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