1/*
2 * PMC-Sierra SPC 8001 SAS/SATA based host adapters driver
3 *
4 * Copyright (c) 2008-2009 USI Co., Ltd.
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 *    notice, this list of conditions, and the following disclaimer,
12 *    without modification.
13 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
14 *    substantially similar to the "NO WARRANTY" disclaimer below
15 *    ("Disclaimer") and any redistribution must be conditioned upon
16 *    including a substantially similar Disclaimer requirement for further
17 *    binary redistribution.
18 * 3. Neither the names of the above-listed copyright holders nor the names
19 *    of any contributors may be used to endorse or promote products derived
20 *    from this software without specific prior written permission.
21 *
22 * Alternatively, this software may be distributed under the terms of the
23 * GNU General Public License ("GPL") version 2 as published by the Free
24 * Software Foundation.
25 *
26 * NO WARRANTY
27 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
28 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
29 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
30 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
31 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
32 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
33 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
34 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
35 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
36 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
37 * POSSIBILITY OF SUCH DAMAGES.
38 *
39 */
40#ifndef _PMC8001_REG_H_
41#define _PMC8001_REG_H_
42
43#include <linux/types.h>
44#include <scsi/libsas.h>
45
46
47/* for Request Opcode of IOMB */
48#define OPC_INB_ECHO				1	/* 0x000 */
49#define OPC_INB_PHYSTART			4	/* 0x004 */
50#define OPC_INB_PHYSTOP				5	/* 0x005 */
51#define OPC_INB_SSPINIIOSTART			6	/* 0x006 */
52#define OPC_INB_SSPINITMSTART			7	/* 0x007 */
53#define OPC_INB_SSPINIEXTIOSTART		8	/* 0x008 */
54#define OPC_INB_DEV_HANDLE_ACCEPT		9	/* 0x009 */
55#define OPC_INB_SSPTGTIOSTART			10	/* 0x00A */
56#define OPC_INB_SSPTGTRSPSTART			11	/* 0x00B */
57#define OPC_INB_SSPINIEDCIOSTART		12	/* 0x00C */
58#define OPC_INB_SSPINIEXTEDCIOSTART		13	/* 0x00D */
59#define OPC_INB_SSPTGTEDCIOSTART		14	/* 0x00E */
60#define OPC_INB_SSP_ABORT			15	/* 0x00F */
61#define OPC_INB_DEREG_DEV_HANDLE		16	/* 0x010 */
62#define OPC_INB_GET_DEV_HANDLE			17	/* 0x011 */
63#define OPC_INB_SMP_REQUEST			18	/* 0x012 */
64/* SMP_RESPONSE is removed */
65#define OPC_INB_SMP_RESPONSE			19	/* 0x013 */
66#define OPC_INB_SMP_ABORT			20	/* 0x014 */
67#define OPC_INB_REG_DEV				22	/* 0x016 */
68#define OPC_INB_SATA_HOST_OPSTART		23	/* 0x017 */
69#define OPC_INB_SATA_ABORT			24	/* 0x018 */
70#define OPC_INB_LOCAL_PHY_CONTROL		25	/* 0x019 */
71#define OPC_INB_GET_DEV_INFO			26	/* 0x01A */
72#define OPC_INB_FW_FLASH_UPDATE			32	/* 0x020 */
73#define OPC_INB_GPIO				34	/* 0x022 */
74#define OPC_INB_SAS_DIAG_MODE_START_END		35	/* 0x023 */
75#define OPC_INB_SAS_DIAG_EXECUTE		36	/* 0x024 */
76#define OPC_INB_SAS_HW_EVENT_ACK		37	/* 0x025 */
77#define OPC_INB_GET_TIME_STAMP			38	/* 0x026 */
78#define OPC_INB_PORT_CONTROL			39	/* 0x027 */
79#define OPC_INB_GET_NVMD_DATA			40	/* 0x028 */
80#define OPC_INB_SET_NVMD_DATA			41	/* 0x029 */
81#define OPC_INB_SET_DEVICE_STATE		42	/* 0x02A */
82#define OPC_INB_GET_DEVICE_STATE		43	/* 0x02B */
83#define OPC_INB_SET_DEV_INFO			44	/* 0x02C */
84#define OPC_INB_SAS_RE_INITIALIZE		45	/* 0x02D */
85
86/* for Response Opcode of IOMB */
87#define OPC_OUB_ECHO				1	/* 0x001 */
88#define OPC_OUB_HW_EVENT			4	/* 0x004 */
89#define OPC_OUB_SSP_COMP			5	/* 0x005 */
90#define OPC_OUB_SMP_COMP			6	/* 0x006 */
91#define OPC_OUB_LOCAL_PHY_CNTRL			7	/* 0x007 */
92#define OPC_OUB_DEV_REGIST			10	/* 0x00A */
93#define OPC_OUB_DEREG_DEV			11	/* 0x00B */
94#define OPC_OUB_GET_DEV_HANDLE			12	/* 0x00C */
95#define OPC_OUB_SATA_COMP			13	/* 0x00D */
96#define OPC_OUB_SATA_EVENT			14	/* 0x00E */
97#define OPC_OUB_SSP_EVENT			15	/* 0x00F */
98#define OPC_OUB_DEV_HANDLE_ARRIV		16	/* 0x010 */
99/* SMP_RECEIVED Notification is removed */
100#define OPC_OUB_SMP_RECV_EVENT			17	/* 0x011 */
101#define OPC_OUB_SSP_RECV_EVENT			18	/* 0x012 */
102#define OPC_OUB_DEV_INFO			19	/* 0x013 */
103#define OPC_OUB_FW_FLASH_UPDATE			20	/* 0x014 */
104#define OPC_OUB_GPIO_RESPONSE			22	/* 0x016 */
105#define OPC_OUB_GPIO_EVENT			23	/* 0x017 */
106#define OPC_OUB_GENERAL_EVENT			24	/* 0x018 */
107#define OPC_OUB_SSP_ABORT_RSP			26	/* 0x01A */
108#define OPC_OUB_SATA_ABORT_RSP			27	/* 0x01B */
109#define OPC_OUB_SAS_DIAG_MODE_START_END		28	/* 0x01C */
110#define OPC_OUB_SAS_DIAG_EXECUTE		29	/* 0x01D */
111#define OPC_OUB_GET_TIME_STAMP			30	/* 0x01E */
112#define OPC_OUB_SAS_HW_EVENT_ACK		31	/* 0x01F */
113#define OPC_OUB_PORT_CONTROL			32	/* 0x020 */
114#define OPC_OUB_SKIP_ENTRY			33	/* 0x021 */
115#define OPC_OUB_SMP_ABORT_RSP			34	/* 0x022 */
116#define OPC_OUB_GET_NVMD_DATA			35	/* 0x023 */
117#define OPC_OUB_SET_NVMD_DATA			36	/* 0x024 */
118#define OPC_OUB_DEVICE_HANDLE_REMOVAL		37	/* 0x025 */
119#define OPC_OUB_SET_DEVICE_STATE		38	/* 0x026 */
120#define OPC_OUB_GET_DEVICE_STATE		39	/* 0x027 */
121#define OPC_OUB_SET_DEV_INFO			40	/* 0x028 */
122#define OPC_OUB_SAS_RE_INITIALIZE		41	/* 0x029 */
123
124/* for phy start*/
125#define SPINHOLD_DISABLE		(0x00 << 14)
126#define SPINHOLD_ENABLE			(0x01 << 14)
127#define LINKMODE_SAS			(0x01 << 12)
128#define LINKMODE_DSATA			(0x02 << 12)
129#define LINKMODE_AUTO			(0x03 << 12)
130#define LINKRATE_15			(0x01 << 8)
131#define LINKRATE_30			(0x02 << 8)
132#define LINKRATE_60			(0x04 << 8)
133
134/* for new SPC controllers MEMBASE III is shared between BIOS and DATA */
135#define GSM_SM_BASE			0x4F0000
136struct mpi_msg_hdr{
137	__le32	header;	/* Bits [11:0]  - Message operation code */
138	/* Bits [15:12] - Message Category */
139	/* Bits [21:16] - Outboundqueue ID for the
140	operation completion message */
141	/* Bits [23:22] - Reserved */
142	/* Bits [28:24] - Buffer Count, indicates how
143	many buffer are allocated for the massage */
144	/* Bits [30:29] - Reserved */
145	/* Bits [31] - Message Valid bit */
146} __attribute__((packed, aligned(4)));
147
148
149/*
150 * brief the data structure of PHY Start Command
151 * use to describe enable the phy (64 bytes)
152 */
153struct phy_start_req {
154	__le32	tag;
155	__le32	ase_sh_lm_slr_phyid;
156	struct sas_identify_frame sas_identify;
157	u32	reserved[5];
158} __attribute__((packed, aligned(4)));
159
160
161/*
162 * brief the data structure of PHY Start Command
163 * use to disable the phy (64 bytes)
164 */
165struct phy_stop_req {
166	__le32	tag;
167	__le32	phy_id;
168	u32	reserved[13];
169} __attribute__((packed, aligned(4)));
170
171
172/* set device bits fis - device to host */
173struct  set_dev_bits_fis {
174	u8	fis_type;	/* 0xA1*/
175	u8	n_i_pmport;
176	/* b7 : n Bit. Notification bit. If set device needs attention. */
177	/* b6 : i Bit. Interrupt Bit */
178	/* b5-b4: reserved2 */
179	/* b3-b0: PM Port */
180	u8 	status;
181	u8	error;
182	u32	_r_a;
183} __attribute__ ((packed));
184/* PIO setup FIS - device to host */
185struct  pio_setup_fis {
186	u8	fis_type;	/* 0x5f */
187	u8	i_d_pmPort;
188	/* b7 : reserved */
189	/* b6 : i bit. Interrupt bit */
190	/* b5 : d bit. data transfer direction. set to 1 for device to host
191	xfer */
192	/* b4 : reserved */
193	/* b3-b0: PM Port */
194	u8	status;
195	u8	error;
196	u8	lbal;
197	u8	lbam;
198	u8	lbah;
199	u8	device;
200	u8	lbal_exp;
201	u8	lbam_exp;
202	u8	lbah_exp;
203	u8	_r_a;
204	u8	sector_count;
205	u8	sector_count_exp;
206	u8	_r_b;
207	u8	e_status;
208	u8	_r_c[2];
209	u8	transfer_count;
210} __attribute__ ((packed));
211
212/*
213 * brief the data structure of SATA Completion Response
214 * use to describe the sata task response (64 bytes)
215 */
216struct sata_completion_resp {
217	__le32	tag;
218	__le32	status;
219	__le32	param;
220	u32	sata_resp[12];
221} __attribute__((packed, aligned(4)));
222
223
224/*
225 * brief the data structure of SAS HW Event Notification
226 * use to alert the host about the hardware event(64 bytes)
227 */
228struct hw_event_resp {
229	__le32	lr_evt_status_phyid_portid;
230	__le32	evt_param;
231	__le32	npip_portstate;
232	struct sas_identify_frame	sas_identify;
233	struct dev_to_host_fis	sata_fis;
234} __attribute__((packed, aligned(4)));
235
236
237/*
238 * brief the data structure of  REGISTER DEVICE Command
239 * use to describe MPI REGISTER DEVICE Command (64 bytes)
240 */
241
242struct reg_dev_req {
243	__le32	tag;
244	__le32	phyid_portid;
245	__le32	dtype_dlr_retry;
246	__le32	firstburstsize_ITNexustimeout;
247	u8	sas_addr[SAS_ADDR_SIZE];
248	__le32	upper_device_id;
249	u32	reserved[8];
250} __attribute__((packed, aligned(4)));
251
252
253/*
254 * brief the data structure of  DEREGISTER DEVICE Command
255 * use to request spc to remove all internal resources associated
256 * with the device id (64 bytes)
257 */
258
259struct dereg_dev_req {
260	__le32	tag;
261	__le32	device_id;
262	u32	reserved[13];
263} __attribute__((packed, aligned(4)));
264
265
266/*
267 * brief the data structure of DEVICE_REGISTRATION Response
268 * use to notify the completion of the device registration  (64 bytes)
269 */
270
271struct dev_reg_resp {
272	__le32	tag;
273	__le32	status;
274	__le32	device_id;
275	u32	reserved[12];
276} __attribute__((packed, aligned(4)));
277
278
279/*
280 * brief the data structure of Local PHY Control Command
281 * use to issue PHY CONTROL to local phy (64 bytes)
282 */
283struct local_phy_ctl_req {
284	__le32	tag;
285	__le32	phyop_phyid;
286	u32	reserved1[13];
287} __attribute__((packed, aligned(4)));
288
289
290/**
291 * brief the data structure of Local Phy Control Response
292 * use to describe MPI Local Phy Control Response (64 bytes)
293 */
294struct local_phy_ctl_resp {
295	__le32	tag;
296	__le32	phyop_phyid;
297	__le32	status;
298	u32	reserved[12];
299} __attribute__((packed, aligned(4)));
300
301
302#define OP_BITS 0x0000FF00
303#define ID_BITS 0x000000FF
304
305/*
306 * brief the data structure of PORT Control Command
307 * use to control port properties (64 bytes)
308 */
309
310struct port_ctl_req {
311	__le32	tag;
312	__le32	portop_portid;
313	__le32	param0;
314	__le32	param1;
315	u32	reserved1[11];
316} __attribute__((packed, aligned(4)));
317
318
319/*
320 * brief the data structure of HW Event Ack Command
321 * use to acknowledge receive HW event (64 bytes)
322 */
323
324struct hw_event_ack_req {
325	__le32	tag;
326	__le32	sea_phyid_portid;
327	__le32	param0;
328	__le32	param1;
329	u32	reserved1[11];
330} __attribute__((packed, aligned(4)));
331
332
333/*
334 * brief the data structure of SSP Completion Response
335 * use to indicate a SSP Completion  (n bytes)
336 */
337struct ssp_completion_resp {
338	__le32	tag;
339	__le32	status;
340	__le32	param;
341	__le32	ssptag_rescv_rescpad;
342	struct ssp_response_iu  ssp_resp_iu;
343	__le32	residual_count;
344} __attribute__((packed, aligned(4)));
345
346
347#define SSP_RESCV_BIT	0x00010000
348
349/*
350 * brief the data structure of SATA EVNET esponse
351 * use to indicate a SATA Completion  (64 bytes)
352 */
353
354struct sata_event_resp {
355	__le32	tag;
356	__le32	event;
357	__le32	port_id;
358	__le32	device_id;
359	u32	reserved[11];
360} __attribute__((packed, aligned(4)));
361
362/*
363 * brief the data structure of SSP EVNET esponse
364 * use to indicate a SSP Completion  (64 bytes)
365 */
366
367struct ssp_event_resp {
368	__le32	tag;
369	__le32	event;
370	__le32	port_id;
371	__le32	device_id;
372	u32	reserved[11];
373} __attribute__((packed, aligned(4)));
374
375/**
376 * brief the data structure of General Event Notification Response
377 * use to describe MPI General Event Notification Response (64 bytes)
378 */
379struct general_event_resp {
380	__le32	status;
381	__le32	inb_IOMB_payload[14];
382} __attribute__((packed, aligned(4)));
383
384
385#define GENERAL_EVENT_PAYLOAD	14
386#define OPCODE_BITS	0x00000fff
387
388/*
389 * brief the data structure of SMP Request Command
390 * use to describe MPI SMP REQUEST Command (64 bytes)
391 */
392struct smp_req {
393	__le32	tag;
394	__le32	device_id;
395	__le32	len_ip_ir;
396	/* Bits [0]  - Indirect response */
397	/* Bits [1] - Indirect Payload */
398	/* Bits [15:2] - Reserved */
399	/* Bits [23:16] - direct payload Len */
400	/* Bits [31:24] - Reserved */
401	u8	smp_req16[16];
402	union {
403		u8	smp_req[32];
404		struct {
405			__le64 long_req_addr;/* sg dma address, LE */
406			__le32 long_req_size;/* LE */
407			u32	_r_a;
408			__le64 long_resp_addr;/* sg dma address, LE */
409			__le32 long_resp_size;/* LE */
410			u32	_r_b;
411			} long_smp_req;/* sequencer extension */
412	};
413} __attribute__((packed, aligned(4)));
414/*
415 * brief the data structure of SMP Completion Response
416 * use to describe MPI SMP Completion Response (64 bytes)
417 */
418struct smp_completion_resp {
419	__le32	tag;
420	__le32	status;
421	__le32	param;
422	__le32	_r_a[12];
423} __attribute__((packed, aligned(4)));
424
425/*
426 *brief the data structure of SSP SMP SATA Abort Command
427 * use to describe MPI SSP SMP & SATA Abort Command (64 bytes)
428 */
429struct task_abort_req {
430	__le32	tag;
431	__le32	device_id;
432	__le32	tag_to_abort;
433	__le32	abort_all;
434	u32	reserved[11];
435} __attribute__((packed, aligned(4)));
436
437/**
438 * brief the data structure of SSP SATA SMP Abort Response
439 * use to describe SSP SMP & SATA Abort Response ( 64 bytes)
440 */
441struct task_abort_resp {
442	__le32	tag;
443	__le32	status;
444	__le32	scp;
445	u32	reserved[12];
446} __attribute__((packed, aligned(4)));
447
448
449/**
450 * brief the data structure of SAS Diagnostic Start/End Command
451 * use to describe MPI SAS Diagnostic Start/End Command (64 bytes)
452 */
453struct sas_diag_start_end_req {
454	__le32	tag;
455	__le32	operation_phyid;
456	u32	reserved[13];
457} __attribute__((packed, aligned(4)));
458
459
460/**
461 * brief the data structure of SAS Diagnostic Execute Command
462 * use to describe MPI SAS Diagnostic Execute Command (64 bytes)
463 */
464struct sas_diag_execute_req{
465	__le32	tag;
466	__le32	cmdtype_cmddesc_phyid;
467	__le32	pat1_pat2;
468	__le32	threshold;
469	__le32	codepat_errmsk;
470	__le32	pmon;
471	__le32	pERF1CTL;
472	u32	reserved[8];
473} __attribute__((packed, aligned(4)));
474
475
476#define SAS_DIAG_PARAM_BYTES 24
477
478/*
479 * brief the data structure of Set Device State Command
480 * use to describe MPI Set Device State Command (64 bytes)
481 */
482struct set_dev_state_req {
483	__le32	tag;
484	__le32	device_id;
485	__le32	nds;
486	u32	reserved[12];
487} __attribute__((packed, aligned(4)));
488
489/*
490 * brief the data structure of sas_re_initialization
491 */
492struct sas_re_initialization_req {
493
494	__le32	tag;
495	__le32	SSAHOLT;/* bit29-set max port;
496			** bit28-set open reject cmd retries.
497			** bit27-set open reject data retries.
498			** bit26-set open reject option, remap:1 or not:0.
499			** bit25-set sata head of line time out.
500			*/
501	__le32 reserved_maxPorts;
502	__le32 open_reject_cmdretries_data_retries;/* cmd retries: 31-bit16;
503						    * data retries: bit15-bit0.
504						    */
505	__le32	sata_hol_tmo;
506	u32	reserved1[10];
507} __attribute__((packed, aligned(4)));
508
509/*
510 * brief the data structure of SATA Start Command
511 * use to describe MPI SATA IO Start Command (64 bytes)
512 */
513
514struct sata_start_req {
515	__le32	tag;
516	__le32	device_id;
517	__le32	data_len;
518	__le32	retfis_ncqtag_atap_dir_m;
519	struct host_to_dev_fis	sata_fis;
520	u32	reserved1;
521	u32	reserved2;
522	u32	addr_low;
523	u32	addr_high;
524	__le32	len;
525	__le32	esgl;
526} __attribute__((packed, aligned(4)));
527
528/**
529 * brief the data structure of SSP INI TM Start Command
530 * use to describe MPI SSP INI TM Start Command (64 bytes)
531 */
532struct ssp_ini_tm_start_req {
533	__le32	tag;
534	__le32	device_id;
535	__le32	relate_tag;
536	__le32	tmf;
537	u8	lun[8];
538	__le32	ds_ads_m;
539	u32	reserved[8];
540} __attribute__((packed, aligned(4)));
541
542
543struct ssp_info_unit {
544	u8	lun[8];/* SCSI Logical Unit Number */
545	u8	reserved1;/* reserved */
546	u8	efb_prio_attr;
547	/* B7   : enabledFirstBurst */
548	/* B6-3 : taskPriority */
549	/* B2-0 : taskAttribute */
550	u8	reserved2;	/* reserved */
551	u8	additional_cdb_len;
552	/* B7-2 : additional_cdb_len */
553	/* B1-0 : reserved */
554	u8	cdb[16];/* The SCSI CDB up to 16 bytes length */
555} __attribute__((packed, aligned(4)));
556
557
558/**
559 * brief the data structure of SSP INI IO Start Command
560 * use to describe MPI SSP INI IO Start Command (64 bytes)
561 */
562struct ssp_ini_io_start_req {
563	__le32	tag;
564	__le32	device_id;
565	__le32	data_len;
566	__le32	dir_m_tlr;
567	struct ssp_info_unit	ssp_iu;
568	__le32	addr_low;
569	__le32	addr_high;
570	__le32	len;
571	__le32	esgl;
572} __attribute__((packed, aligned(4)));
573
574
575/**
576 * brief the data structure of Firmware download
577 * use to describe MPI FW DOWNLOAD Command (64 bytes)
578 */
579struct fw_flash_Update_req {
580	__le32	tag;
581	__le32	cur_image_offset;
582	__le32	cur_image_len;
583	__le32	total_image_len;
584	u32	reserved0[7];
585	__le32	sgl_addr_lo;
586	__le32	sgl_addr_hi;
587	__le32	len;
588	__le32	ext_reserved;
589} __attribute__((packed, aligned(4)));
590
591
592#define FWFLASH_IOMB_RESERVED_LEN 0x07
593/**
594 * brief the data structure of FW_FLASH_UPDATE Response
595 * use to describe MPI FW_FLASH_UPDATE Response (64 bytes)
596 *
597 */
598struct fw_flash_Update_resp {
599	__le32	tag;
600	__le32	status;
601	u32	reserved[13];
602} __attribute__((packed, aligned(4)));
603
604
605/**
606 * brief the data structure of Get NVM Data Command
607 * use to get data from NVM in HBA(64 bytes)
608 */
609struct get_nvm_data_req {
610	__le32	tag;
611	__le32	len_ir_vpdd;
612	__le32	vpd_offset;
613	u32	reserved[8];
614	__le32	resp_addr_lo;
615	__le32	resp_addr_hi;
616	__le32	resp_len;
617	u32	reserved1;
618} __attribute__((packed, aligned(4)));
619
620
621struct set_nvm_data_req {
622	__le32	tag;
623	__le32	len_ir_vpdd;
624	__le32	vpd_offset;
625	__le32	reserved[8];
626	__le32	resp_addr_lo;
627	__le32	resp_addr_hi;
628	__le32	resp_len;
629	u32	reserved1;
630} __attribute__((packed, aligned(4)));
631
632
633#define TWI_DEVICE	0x0
634#define C_SEEPROM	0x1
635#define VPD_FLASH	0x4
636#define AAP1_RDUMP	0x5
637#define IOP_RDUMP	0x6
638#define EXPAN_ROM	0x7
639
640#define IPMode		0x80000000
641#define NVMD_TYPE	0x0000000F
642#define NVMD_STAT	0x0000FFFF
643#define NVMD_LEN	0xFF000000
644/**
645 * brief the data structure of Get NVMD Data Response
646 * use to describe MPI Get NVMD Data Response (64 bytes)
647 */
648struct get_nvm_data_resp {
649	__le32		tag;
650	__le32		ir_tda_bn_dps_das_nvm;
651	__le32		dlen_status;
652	__le32		nvm_data[12];
653} __attribute__((packed, aligned(4)));
654
655
656/**
657 * brief the data structure of SAS Diagnostic Start/End Response
658 * use to describe MPI SAS Diagnostic Start/End Response (64 bytes)
659 *
660 */
661struct sas_diag_start_end_resp {
662	__le32		tag;
663	__le32		status;
664	u32		reserved[13];
665} __attribute__((packed, aligned(4)));
666
667
668/**
669 * brief the data structure of SAS Diagnostic Execute Response
670 * use to describe MPI SAS Diagnostic Execute Response (64 bytes)
671 *
672 */
673struct sas_diag_execute_resp {
674	__le32		tag;
675	__le32		cmdtype_cmddesc_phyid;
676	__le32		Status;
677	__le32		ReportData;
678	u32		reserved[11];
679} __attribute__((packed, aligned(4)));
680
681
682/**
683 * brief the data structure of Set Device State Response
684 * use to describe MPI Set Device State Response (64 bytes)
685 *
686 */
687struct set_dev_state_resp {
688	__le32		tag;
689	__le32		status;
690	__le32		device_id;
691	__le32		pds_nds;
692	u32		reserved[11];
693} __attribute__((packed, aligned(4)));
694
695
696#define NDS_BITS 0x0F
697#define PDS_BITS 0xF0
698
699/*
700 * HW Events type
701 */
702
703#define HW_EVENT_RESET_START			0x01
704#define HW_EVENT_CHIP_RESET_COMPLETE		0x02
705#define HW_EVENT_PHY_STOP_STATUS		0x03
706#define HW_EVENT_SAS_PHY_UP			0x04
707#define HW_EVENT_SATA_PHY_UP			0x05
708#define HW_EVENT_SATA_SPINUP_HOLD		0x06
709#define HW_EVENT_PHY_DOWN			0x07
710#define HW_EVENT_PORT_INVALID			0x08
711#define HW_EVENT_BROADCAST_CHANGE		0x09
712#define HW_EVENT_PHY_ERROR			0x0A
713#define HW_EVENT_BROADCAST_SES			0x0B
714#define HW_EVENT_INBOUND_CRC_ERROR		0x0C
715#define HW_EVENT_HARD_RESET_RECEIVED		0x0D
716#define HW_EVENT_MALFUNCTION			0x0E
717#define HW_EVENT_ID_FRAME_TIMEOUT		0x0F
718#define HW_EVENT_BROADCAST_EXP			0x10
719#define HW_EVENT_PHY_START_STATUS		0x11
720#define HW_EVENT_LINK_ERR_INVALID_DWORD		0x12
721#define HW_EVENT_LINK_ERR_DISPARITY_ERROR	0x13
722#define HW_EVENT_LINK_ERR_CODE_VIOLATION	0x14
723#define HW_EVENT_LINK_ERR_LOSS_OF_DWORD_SYNCH	0x15
724#define HW_EVENT_LINK_ERR_PHY_RESET_FAILED	0x16
725#define HW_EVENT_PORT_RECOVERY_TIMER_TMO	0x17
726#define HW_EVENT_PORT_RECOVER			0x18
727#define HW_EVENT_PORT_RESET_TIMER_TMO		0x19
728#define HW_EVENT_PORT_RESET_COMPLETE		0x20
729#define EVENT_BROADCAST_ASYNCH_EVENT		0x21
730
731/* port state */
732#define PORT_NOT_ESTABLISHED			0x00
733#define PORT_VALID				0x01
734#define PORT_LOSTCOMM				0x02
735#define PORT_IN_RESET				0x04
736#define PORT_INVALID				0x08
737
738/*
739 * SSP/SMP/SATA IO Completion Status values
740 */
741
742#define IO_SUCCESS				0x00
743#define IO_ABORTED				0x01
744#define IO_OVERFLOW				0x02
745#define IO_UNDERFLOW				0x03
746#define IO_FAILED				0x04
747#define IO_ABORT_RESET				0x05
748#define IO_NOT_VALID				0x06
749#define IO_NO_DEVICE				0x07
750#define IO_ILLEGAL_PARAMETER			0x08
751#define IO_LINK_FAILURE				0x09
752#define IO_PROG_ERROR				0x0A
753#define IO_EDC_IN_ERROR				0x0B
754#define IO_EDC_OUT_ERROR			0x0C
755#define IO_ERROR_HW_TIMEOUT			0x0D
756#define IO_XFER_ERROR_BREAK			0x0E
757#define IO_XFER_ERROR_PHY_NOT_READY		0x0F
758#define IO_OPEN_CNX_ERROR_PROTOCOL_NOT_SUPPORTED	0x10
759#define IO_OPEN_CNX_ERROR_ZONE_VIOLATION		0x11
760#define IO_OPEN_CNX_ERROR_BREAK				0x12
761#define IO_OPEN_CNX_ERROR_IT_NEXUS_LOSS			0x13
762#define IO_OPEN_CNX_ERROR_BAD_DESTINATION		0x14
763#define IO_OPEN_CNX_ERROR_CONNECTION_RATE_NOT_SUPPORTED	0x15
764#define IO_OPEN_CNX_ERROR_STP_RESOURCES_BUSY		0x16
765#define IO_OPEN_CNX_ERROR_WRONG_DESTINATION		0x17
766#define IO_OPEN_CNX_ERROR_UNKNOWN_ERROR			0x18
767#define IO_XFER_ERROR_NAK_RECEIVED			0x19
768#define IO_XFER_ERROR_ACK_NAK_TIMEOUT			0x1A
769#define IO_XFER_ERROR_PEER_ABORTED			0x1B
770#define IO_XFER_ERROR_RX_FRAME				0x1C
771#define IO_XFER_ERROR_DMA				0x1D
772#define IO_XFER_ERROR_CREDIT_TIMEOUT			0x1E
773#define IO_XFER_ERROR_SATA_LINK_TIMEOUT			0x1F
774#define IO_XFER_ERROR_SATA				0x20
775#define IO_XFER_ERROR_ABORTED_DUE_TO_SRST		0x22
776#define IO_XFER_ERROR_REJECTED_NCQ_MODE			0x21
777#define IO_XFER_ERROR_ABORTED_NCQ_MODE			0x23
778#define IO_XFER_OPEN_RETRY_TIMEOUT			0x24
779#define IO_XFER_SMP_RESP_CONNECTION_ERROR		0x25
780#define IO_XFER_ERROR_UNEXPECTED_PHASE			0x26
781#define IO_XFER_ERROR_XFER_RDY_OVERRUN			0x27
782#define IO_XFER_ERROR_XFER_RDY_NOT_EXPECTED		0x28
783
784#define IO_XFER_ERROR_CMD_ISSUE_ACK_NAK_TIMEOUT		0x30
785#define IO_XFER_ERROR_CMD_ISSUE_BREAK_BEFORE_ACK_NAK	0x31
786#define IO_XFER_ERROR_CMD_ISSUE_PHY_DOWN_BEFORE_ACK_NAK	0x32
787
788#define IO_XFER_ERROR_OFFSET_MISMATCH			0x34
789#define IO_XFER_ERROR_XFER_ZERO_DATA_LEN		0x35
790#define IO_XFER_CMD_FRAME_ISSUED			0x36
791#define IO_ERROR_INTERNAL_SMP_RESOURCE			0x37
792#define IO_PORT_IN_RESET				0x38
793#define IO_DS_NON_OPERATIONAL				0x39
794#define IO_DS_IN_RECOVERY				0x3A
795#define IO_TM_TAG_NOT_FOUND				0x3B
796#define IO_XFER_PIO_SETUP_ERROR				0x3C
797#define IO_SSP_EXT_IU_ZERO_LEN_ERROR			0x3D
798#define IO_DS_IN_ERROR					0x3E
799#define IO_OPEN_CNX_ERROR_HW_RESOURCE_BUSY		0x3F
800#define IO_ABORT_IN_PROGRESS				0x40
801#define IO_ABORT_DELAYED				0x41
802#define IO_INVALID_LENGTH				0x42
803#define IO_FATAL_ERROR					0x51
804
805/* WARNING: This error code must always be the last number.
806 * If you add error code, modify this code also
807 * It is used as an index
808 */
809#define IO_ERROR_UNKNOWN_GENERIC			0x43
810
811/* MSGU CONFIGURATION  TABLE*/
812
813#define SPC_MSGU_CFG_TABLE_UPDATE		0x01/* Inbound doorbell bit0 */
814#define SPC_MSGU_CFG_TABLE_RESET		0x02/* Inbound doorbell bit1 */
815#define SPC_MSGU_CFG_TABLE_FREEZE		0x04/* Inbound doorbell bit2 */
816#define SPC_MSGU_CFG_TABLE_UNFREEZE		0x08/* Inbound doorbell bit4 */
817#define MSGU_IBDB_SET				0x04
818#define MSGU_HOST_INT_STATUS			0x08
819#define MSGU_HOST_INT_MASK			0x0C
820#define MSGU_IOPIB_INT_STATUS			0x18
821#define MSGU_IOPIB_INT_MASK			0x1C
822#define MSGU_IBDB_CLEAR				0x20/* RevB - Host not use */
823#define MSGU_MSGU_CONTROL			0x24
824#define MSGU_ODR				0x3C/* RevB */
825#define MSGU_ODCR				0x40/* RevB */
826#define MSGU_SCRATCH_PAD_0			0x44
827#define MSGU_SCRATCH_PAD_1			0x48
828#define MSGU_SCRATCH_PAD_2			0x4C
829#define MSGU_SCRATCH_PAD_3			0x50
830#define MSGU_HOST_SCRATCH_PAD_0			0x54
831#define MSGU_HOST_SCRATCH_PAD_1			0x58
832#define MSGU_HOST_SCRATCH_PAD_2			0x5C
833#define MSGU_HOST_SCRATCH_PAD_3			0x60
834#define MSGU_HOST_SCRATCH_PAD_4			0x64
835#define MSGU_HOST_SCRATCH_PAD_5			0x68
836#define MSGU_HOST_SCRATCH_PAD_6			0x6C
837#define MSGU_HOST_SCRATCH_PAD_7			0x70
838#define MSGU_ODMR				0x74/* RevB */
839
840/* bit definition for ODMR register */
841#define ODMR_MASK_ALL				0xFFFFFFFF/* mask all
842					interrupt vector */
843#define ODMR_CLEAR_ALL				0/* clear all
844					interrupt vector */
845/* bit definition for ODCR register */
846#define ODCR_CLEAR_ALL		0xFFFFFFFF   /* mask all
847					interrupt vector*/
848/* MSIX Interupts */
849#define MSIX_TABLE_OFFSET		0x2000
850#define MSIX_TABLE_ELEMENT_SIZE		0x10
851#define MSIX_INTERRUPT_CONTROL_OFFSET	0xC
852#define MSIX_TABLE_BASE	  (MSIX_TABLE_OFFSET + MSIX_INTERRUPT_CONTROL_OFFSET)
853#define MSIX_INTERRUPT_DISABLE		0x1
854#define MSIX_INTERRUPT_ENABLE		0x0
855
856
857/* state definition for Scratch Pad1 register */
858#define SCRATCH_PAD1_POR		0x00  /* power on reset state */
859#define SCRATCH_PAD1_SFR		0x01  /* soft reset state */
860#define SCRATCH_PAD1_ERR		0x02  /* error state */
861#define SCRATCH_PAD1_RDY		0x03  /* ready state */
862#define SCRATCH_PAD1_RST		0x04  /* soft reset toggle flag */
863#define SCRATCH_PAD1_AAP1RDY_RST	0x08  /* AAP1 ready for soft reset */
864#define SCRATCH_PAD1_STATE_MASK		0xFFFFFFF0   /* ScratchPad1
865 Mask, bit1-0 State, bit2 Soft Reset, bit3 FW RDY for Soft Reset */
866#define SCRATCH_PAD1_RESERVED		0x000003F8   /* Scratch Pad1
867 Reserved bit 3 to 9 */
868
869 /* state definition for Scratch Pad2 register */
870#define SCRATCH_PAD2_POR		0x00  /* power on state */
871#define SCRATCH_PAD2_SFR		0x01  /* soft reset state */
872#define SCRATCH_PAD2_ERR		0x02  /* error state */
873#define SCRATCH_PAD2_RDY		0x03  /* ready state */
874#define SCRATCH_PAD2_FWRDY_RST		0x04  /* FW ready for soft reset flag*/
875#define SCRATCH_PAD2_IOPRDY_RST		0x08  /* IOP ready for soft reset */
876#define SCRATCH_PAD2_STATE_MASK		0xFFFFFFF4 /* ScratchPad 2
877 Mask, bit1-0 State */
878#define SCRATCH_PAD2_RESERVED		0x000003FC   /* Scratch Pad1
879 Reserved bit 2 to 9 */
880
881#define SCRATCH_PAD_ERROR_MASK		0xFFFFFC00   /* Error mask bits */
882#define SCRATCH_PAD_STATE_MASK		0x00000003   /* State Mask bits */
883
884/* main configuration offset - byte offset */
885#define MAIN_SIGNATURE_OFFSET		0x00/* DWORD 0x00 */
886#define MAIN_INTERFACE_REVISION		0x04/* DWORD 0x01 */
887#define MAIN_FW_REVISION		0x08/* DWORD 0x02 */
888#define MAIN_MAX_OUTSTANDING_IO_OFFSET	0x0C/* DWORD 0x03 */
889#define MAIN_MAX_SGL_OFFSET		0x10/* DWORD 0x04 */
890#define MAIN_CNTRL_CAP_OFFSET		0x14/* DWORD 0x05 */
891#define MAIN_GST_OFFSET			0x18/* DWORD 0x06 */
892#define MAIN_IBQ_OFFSET			0x1C/* DWORD 0x07 */
893#define MAIN_OBQ_OFFSET			0x20/* DWORD 0x08 */
894#define MAIN_IQNPPD_HPPD_OFFSET		0x24/* DWORD 0x09 */
895#define MAIN_OB_HW_EVENT_PID03_OFFSET	0x28/* DWORD 0x0A */
896#define MAIN_OB_HW_EVENT_PID47_OFFSET	0x2C/* DWORD 0x0B */
897#define MAIN_OB_NCQ_EVENT_PID03_OFFSET	0x30/* DWORD 0x0C */
898#define MAIN_OB_NCQ_EVENT_PID47_OFFSET	0x34/* DWORD 0x0D */
899#define MAIN_TITNX_EVENT_PID03_OFFSET	0x38/* DWORD 0x0E */
900#define MAIN_TITNX_EVENT_PID47_OFFSET	0x3C/* DWORD 0x0F */
901#define MAIN_OB_SSP_EVENT_PID03_OFFSET	0x40/* DWORD 0x10 */
902#define MAIN_OB_SSP_EVENT_PID47_OFFSET	0x44/* DWORD 0x11 */
903#define MAIN_OB_SMP_EVENT_PID03_OFFSET	0x48/* DWORD 0x12 */
904#define MAIN_OB_SMP_EVENT_PID47_OFFSET	0x4C/* DWORD 0x13 */
905#define MAIN_EVENT_LOG_ADDR_HI		0x50/* DWORD 0x14 */
906#define MAIN_EVENT_LOG_ADDR_LO		0x54/* DWORD 0x15 */
907#define MAIN_EVENT_LOG_BUFF_SIZE	0x58/* DWORD 0x16 */
908#define MAIN_EVENT_LOG_OPTION		0x5C/* DWORD 0x17 */
909#define MAIN_IOP_EVENT_LOG_ADDR_HI	0x60/* DWORD 0x18 */
910#define MAIN_IOP_EVENT_LOG_ADDR_LO	0x64/* DWORD 0x19 */
911#define MAIN_IOP_EVENT_LOG_BUFF_SIZE	0x68/* DWORD 0x1A */
912#define MAIN_IOP_EVENT_LOG_OPTION	0x6C/* DWORD 0x1B */
913#define MAIN_FATAL_ERROR_INTERRUPT	0x70/* DWORD 0x1C */
914#define MAIN_FATAL_ERROR_RDUMP0_OFFSET	0x74/* DWORD 0x1D */
915#define MAIN_FATAL_ERROR_RDUMP0_LENGTH	0x78/* DWORD 0x1E */
916#define MAIN_FATAL_ERROR_RDUMP1_OFFSET	0x7C/* DWORD 0x1F */
917#define MAIN_FATAL_ERROR_RDUMP1_LENGTH	0x80/* DWORD 0x20 */
918#define MAIN_HDA_FLAGS_OFFSET		0x84/* DWORD 0x21 */
919#define MAIN_ANALOG_SETUP_OFFSET	0x88/* DWORD 0x22 */
920
921/* Gereral Status Table offset - byte offset */
922#define GST_GSTLEN_MPIS_OFFSET		0x00
923#define GST_IQ_FREEZE_STATE0_OFFSET	0x04
924#define GST_IQ_FREEZE_STATE1_OFFSET	0x08
925#define GST_MSGUTCNT_OFFSET		0x0C
926#define GST_IOPTCNT_OFFSET		0x10
927#define GST_PHYSTATE_OFFSET		0x18
928#define GST_PHYSTATE0_OFFSET		0x18
929#define GST_PHYSTATE1_OFFSET		0x1C
930#define GST_PHYSTATE2_OFFSET		0x20
931#define GST_PHYSTATE3_OFFSET		0x24
932#define GST_PHYSTATE4_OFFSET		0x28
933#define GST_PHYSTATE5_OFFSET		0x2C
934#define GST_PHYSTATE6_OFFSET		0x30
935#define GST_PHYSTATE7_OFFSET		0x34
936#define GST_RERRINFO_OFFSET		0x44
937
938/* General Status Table - MPI state */
939#define GST_MPI_STATE_UNINIT		0x00
940#define GST_MPI_STATE_INIT		0x01
941#define GST_MPI_STATE_TERMINATION	0x02
942#define GST_MPI_STATE_ERROR		0x03
943#define GST_MPI_STATE_MASK		0x07
944
945#define MBIC_NMI_ENABLE_VPE0_IOP	0x000418
946#define MBIC_NMI_ENABLE_VPE0_AAP1	0x000418
947/* PCIE registers - BAR2(0x18), BAR1(win) 0x010000 */
948#define PCIE_EVENT_INTERRUPT_ENABLE	0x003040
949#define PCIE_EVENT_INTERRUPT		0x003044
950#define PCIE_ERROR_INTERRUPT_ENABLE	0x003048
951#define PCIE_ERROR_INTERRUPT		0x00304C
952/* signature definition for host scratch pad0 register */
953#define SPC_SOFT_RESET_SIGNATURE	0x252acbcd
954/* Signature for Soft Reset */
955
956/* SPC Reset register - BAR4(0x20), BAR2(win) (need dynamic mapping) */
957#define SPC_REG_RESET			0x000000/* reset register */
958
959/* bit difination for SPC_RESET register */
960#define   SPC_REG_RESET_OSSP		0x00000001
961#define   SPC_REG_RESET_RAAE		0x00000002
962#define   SPC_REG_RESET_PCS_SPBC	0x00000004
963#define   SPC_REG_RESET_PCS_IOP_SS	0x00000008
964#define   SPC_REG_RESET_PCS_AAP1_SS	0x00000010
965#define   SPC_REG_RESET_PCS_AAP2_SS	0x00000020
966#define   SPC_REG_RESET_PCS_LM		0x00000040
967#define   SPC_REG_RESET_PCS		0x00000080
968#define   SPC_REG_RESET_GSM		0x00000100
969#define   SPC_REG_RESET_DDR2		0x00010000
970#define   SPC_REG_RESET_BDMA_CORE	0x00020000
971#define   SPC_REG_RESET_BDMA_SXCBI	0x00040000
972#define   SPC_REG_RESET_PCIE_AL_SXCBI	0x00080000
973#define   SPC_REG_RESET_PCIE_PWR	0x00100000
974#define   SPC_REG_RESET_PCIE_SFT	0x00200000
975#define   SPC_REG_RESET_PCS_SXCBI	0x00400000
976#define   SPC_REG_RESET_LMS_SXCBI	0x00800000
977#define   SPC_REG_RESET_PMIC_SXCBI	0x01000000
978#define   SPC_REG_RESET_PMIC_CORE	0x02000000
979#define   SPC_REG_RESET_PCIE_PC_SXCBI	0x04000000
980#define   SPC_REG_RESET_DEVICE		0x80000000
981
982/* registers for BAR Shifting - BAR2(0x18), BAR1(win) */
983#define SPC_IBW_AXI_TRANSLATION_LOW	0x003258
984
985#define MBIC_AAP1_ADDR_BASE		0x060000
986#define MBIC_IOP_ADDR_BASE		0x070000
987#define GSM_ADDR_BASE			0x0700000
988/* Dynamic map through Bar4 - 0x00700000 */
989#define GSM_CONFIG_RESET		0x00000000
990#define RAM_ECC_DB_ERR			0x00000018
991#define GSM_READ_ADDR_PARITY_INDIC	0x00000058
992#define GSM_WRITE_ADDR_PARITY_INDIC	0x00000060
993#define GSM_WRITE_DATA_PARITY_INDIC	0x00000068
994#define GSM_READ_ADDR_PARITY_CHECK	0x00000038
995#define GSM_WRITE_ADDR_PARITY_CHECK	0x00000040
996#define GSM_WRITE_DATA_PARITY_CHECK	0x00000048
997
998#define RB6_ACCESS_REG			0x6A0000
999#define HDAC_EXEC_CMD			0x0002
1000#define HDA_C_PA			0xcb
1001#define HDA_SEQ_ID_BITS			0x00ff0000
1002#define HDA_GSM_OFFSET_BITS		0x00FFFFFF
1003#define MBIC_AAP1_ADDR_BASE		0x060000
1004#define MBIC_IOP_ADDR_BASE		0x070000
1005#define GSM_ADDR_BASE			0x0700000
1006#define SPC_TOP_LEVEL_ADDR_BASE		0x000000
1007#define GSM_CONFIG_RESET_VALUE          0x00003b00
1008#define GPIO_ADDR_BASE                  0x00090000
1009#define GPIO_GPIO_0_0UTPUT_CTL_OFFSET   0x0000010c
1010
1011/* RB6 offset */
1012#define SPC_RB6_OFFSET			0x80C0
1013/* Magic number of  soft reset for RB6 */
1014#define RB6_MAGIC_NUMBER_RST		0x1234
1015
1016/* Device Register status */
1017#define DEVREG_SUCCESS					0x00
1018#define DEVREG_FAILURE_OUT_OF_RESOURCE			0x01
1019#define DEVREG_FAILURE_DEVICE_ALREADY_REGISTERED	0x02
1020#define DEVREG_FAILURE_INVALID_PHY_ID			0x03
1021#define DEVREG_FAILURE_PHY_ID_ALREADY_REGISTERED	0x04
1022#define DEVREG_FAILURE_PORT_ID_OUT_OF_RANGE		0x05
1023#define DEVREG_FAILURE_PORT_NOT_VALID_STATE		0x06
1024#define DEVREG_FAILURE_DEVICE_TYPE_NOT_VALID		0x07
1025
1026#define GSM_BASE					0x4F0000
1027#define SHIFT_REG_64K_MASK				0xffff0000
1028#define SHIFT_REG_BIT_SHIFT				8
1029#endif
1030
1031