Add FreeBSD's mpr(4) driver for LSI Fusion-MPT 3/3.5 SAS controllers.
[dragonfly.git] / sys / dev / raid / mpr / mpi / mpi2_ra.h
1 /*-
2  * Copyright (c) 2012-2015 LSI Corp.
3  * Copyright (c) 2013-2016 Avago Technologies
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  * 3. Neither the name of the author nor the names of any co-contributors
15  *    may be used to endorse or promote products derived from this software
16  *    without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28  * SUCH DAMAGE.
29  *
30  * Avago Technologies (LSI) MPT-Fusion Host Adapter FreeBSD
31  *
32  * $FreeBSD: head/sys/dev/mpr/mpi/mpi2_ra.h 299263 2016-05-09 16:12:32Z slm $
33  */
34
35 /*
36  *  Copyright (c) 2012-2015 LSI Corporation.
37  *  Copyright (c) 2013-2016 Avago Technologies
38  *  All rights reserved.
39  *
40  *
41  *           Name:  mpi2_ra.h
42  *          Title:  MPI RAID Accelerator messages and structures
43  *  Creation Date:  April 13, 2009
44  *
45  *  mpi2_ra.h Version:  02.00.01
46  *
47  *  Version History
48  *  ---------------
49  *
50  *  Date      Version   Description
51  *  --------  --------  ------------------------------------------------------
52  *  05-06-09  02.00.00  Initial version.
53  *  11-18-14  02.00.01  Updated copyright information.
54  *  --------------------------------------------------------------------------
55  */
56
57 #ifndef MPI2_RA_H
58 #define MPI2_RA_H
59
60 /* generic structure for RAID Accelerator Control Block */
61 typedef struct _MPI2_RAID_ACCELERATOR_CONTROL_BLOCK
62 {
63     U32                 Reserved[8];                /* 0x00 */
64     U32                 RaidAcceleratorCDB[1];      /* 0x20 */
65 } MPI2_RAID_ACCELERATOR_CONTROL_BLOCK,
66   MPI2_POINTER PTR_MPI2_RAID_ACCELERATOR_CONTROL_BLOCK,
67   Mpi2RAIDAcceleratorControlBlock_t,
68   MPI2_POINTER pMpi2RAIDAcceleratorControlBlock_t;
69
70
71 /******************************************************************************
72 *
73 *        RAID Accelerator Messages
74 *
75 *******************************************************************************/
76
77 /* RAID Accelerator Request Message */
78 typedef struct _MPI2_RAID_ACCELERATOR_REQUEST
79 {
80     U16                     Reserved0;                          /* 0x00 */
81     U8                      ChainOffset;                        /* 0x02 */
82     U8                      Function;                           /* 0x03 */
83     U16                     Reserved1;                          /* 0x04 */
84     U8                      Reserved2;                          /* 0x06 */
85     U8                      MsgFlags;                           /* 0x07 */
86     U8                      VP_ID;                              /* 0x08 */
87     U8                      VF_ID;                              /* 0x09 */
88     U16                     Reserved3;                          /* 0x0A */
89     U64                     RaidAcceleratorControlBlockAddress; /* 0x0C */
90     U8                      DmaEngineNumber;                    /* 0x14 */
91     U8                      Reserved4;                          /* 0x15 */
92     U16                     Reserved5;                          /* 0x16 */
93     U32                     Reserved6;                          /* 0x18 */
94     U32                     Reserved7;                          /* 0x1C */
95     U32                     Reserved8;                          /* 0x20 */
96 } MPI2_RAID_ACCELERATOR_REQUEST, MPI2_POINTER PTR_MPI2_RAID_ACCELERATOR_REQUEST,
97   Mpi2RAIDAcceleratorRequest_t, MPI2_POINTER pMpi2RAIDAcceleratorRequest_t;
98
99
100 /* RAID Accelerator Error Reply Message */
101 typedef struct _MPI2_RAID_ACCELERATOR_REPLY
102 {
103     U16                     Reserved0;                      /* 0x00 */
104     U8                      MsgLength;                      /* 0x02 */
105     U8                      Function;                       /* 0x03 */
106     U16                     Reserved1;                      /* 0x04 */
107     U8                      Reserved2;                      /* 0x06 */
108     U8                      MsgFlags;                       /* 0x07 */
109     U8                      VP_ID;                          /* 0x08 */
110     U8                      VF_ID;                          /* 0x09 */
111     U16                     Reserved3;                      /* 0x0A */
112     U16                     Reserved4;                      /* 0x0C */
113     U16                     IOCStatus;                      /* 0x0E */
114     U32                     IOCLogInfo;                     /* 0x10 */
115     U32                     ProductSpecificData[3];         /* 0x14 */
116 } MPI2_RAID_ACCELERATOR_REPLY, MPI2_POINTER PTR_MPI2_RAID_ACCELERATOR_REPLY,
117   Mpi2RAIDAcceleratorReply_t, MPI2_POINTER pMpi2RAIDAcceleratorReply_t;
118
119
120 #endif
121
122