xref: /freebsd/sys/dev/mpr/mpi/mpi2_hbd.h (revision 8e95079e175854b84e57c521b34b4b52f7ae9cb1)
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_hbd.h
36  *          Title:  MPI Host Based Discovery messages and structures
37  *  Creation Date:  October 21, 2009
38  *
39  *  mpi2_hbd.h Version:  02.00.04
40  *
41  *  NOTE: Names (typedefs, defines, etc.) beginning with an MPI25 or Mpi25
42  *        prefix are for use only on MPI v2.5 products, and must not be used
43  *        with MPI v2.0 products. Unless otherwise noted, names beginning with
44  *        MPI2 or Mpi2 are for use with both MPI v2.0 and MPI v2.5 products.
45  *
46  *  Version History
47  *  ---------------
48  *
49  *  Date      Version   Description
50  *  --------  --------  ------------------------------------------------------
51  *  10-28-09  02.00.00  Initial version.
52  *  08-11-10  02.00.01  Removed PortGroups, DmaGroup, and ControlGroup from
53  *                      HBD Action request, replaced by AdditionalInfo field.
54  *  11-18-11  02.00.02  Incorporating additions for MPI v2.5.
55  *  11-18-14  02.00.03  Updated copyright information.
56  *  02-17-16  02.00.04  Added SAS 4 22.5 gbs speed support.
57  *  --------------------------------------------------------------------------
58  */
59 
60 #ifndef MPI2_HBD_H
61 #define MPI2_HBD_H
62 
63 /****************************************************************************
64 *  Host Based Discovery Action messages
65 ****************************************************************************/
66 
67 /* Host Based Discovery Action Request Message */
68 typedef struct _MPI2_HBD_ACTION_REQUEST
69 {
70     U8                      Operation;          /* 0x00 */
71     U8                      Reserved1;          /* 0x01 */
72     U8                      ChainOffset;        /* 0x02 */
73     U8                      Function;           /* 0x03 */
74     U16                     DevHandle;          /* 0x04 */
75     U8                      Reserved2;          /* 0x06 */
76     U8                      MsgFlags;           /* 0x07 */
77     U8                      VP_ID;              /* 0x08 */
78     U8                      VF_ID;              /* 0x09 */
79     U16                     Reserved3;          /* 0x0A */
80     U32                     Reserved4;          /* 0x0C */
81     U64                     SASAddress;         /* 0x10 */
82     U32                     Reserved5;          /* 0x18 */
83     U32                     HbdDeviceInfo;      /* 0x1C */
84     U16                     ParentDevHandle;    /* 0x20 */
85     U16                     MaxQDepth;          /* 0x22 */
86     U8                      FirstPhyIdentifier; /* 0x24 */
87     U8                      Port;               /* 0x25 */
88     U8                      MaxConnections;     /* 0x26 */
89     U8                      MaxRate;            /* 0x27 */
90     U32                     AdditionalInfo;     /* 0x28 */
91     U16                     InitialAWT;         /* 0x2C */
92     U16                     Reserved7;          /* 0x2E */
93     U32                     Reserved8;          /* 0x30 */
94 } MPI2_HBD_ACTION_REQUEST, MPI2_POINTER PTR_MPI2_HBD_ACTION_REQUEST,
95   Mpi2HbdActionRequest_t, MPI2_POINTER pMpi2HbdActionRequest_t;
96 
97 /* values for the Operation field */
98 #define MPI2_HBD_OP_ADD_DEVICE                  (0x01)
99 #define MPI2_HBD_OP_REMOVE_DEVICE               (0x02)
100 #define MPI2_HBD_OP_UPDATE_DEVICE               (0x03)
101 
102 /* values for the HbdDeviceInfo field */
103 #define MPI2_HBD_DEVICE_INFO_VIRTUAL_DEVICE     (0x00004000)
104 #define MPI2_HBD_DEVICE_INFO_ATAPI_DEVICE       (0x00002000)
105 #define MPI2_HBD_DEVICE_INFO_DIRECT_ATTACH      (0x00000800)
106 #define MPI2_HBD_DEVICE_INFO_SSP_TARGET         (0x00000400)
107 #define MPI2_HBD_DEVICE_INFO_STP_TARGET         (0x00000200)
108 #define MPI2_HBD_DEVICE_INFO_SMP_TARGET         (0x00000100)
109 #define MPI2_HBD_DEVICE_INFO_SATA_DEVICE        (0x00000080)
110 #define MPI2_HBD_DEVICE_INFO_SSP_INITIATOR      (0x00000040)
111 #define MPI2_HBD_DEVICE_INFO_STP_INITIATOR      (0x00000020)
112 #define MPI2_HBD_DEVICE_INFO_SMP_INITIATOR      (0x00000010)
113 #define MPI2_HBD_DEVICE_INFO_SATA_HOST          (0x00000008)
114 
115 #define MPI2_HBD_DEVICE_INFO_MASK_DEVICE_TYPE   (0x00000007)
116 #define MPI2_HBD_DEVICE_INFO_NO_DEVICE          (0x00000000)
117 #define MPI2_HBD_DEVICE_INFO_END_DEVICE         (0x00000001)
118 #define MPI2_HBD_DEVICE_INFO_EDGE_EXPANDER      (0x00000002)
119 #define MPI2_HBD_DEVICE_INFO_FANOUT_EXPANDER    (0x00000003)
120 
121 /* values for the MaxRate field */
122 #define MPI2_HBD_MAX_RATE_MASK                  (0x0F)
123 #define MPI2_HBD_MAX_RATE_1_5                   (0x08)
124 #define MPI2_HBD_MAX_RATE_3_0                   (0x09)
125 #define MPI2_HBD_MAX_RATE_6_0                   (0x0A)
126 #define MPI25_HBD_MAX_RATE_12_0                 (0x0B)
127 #define MPI26_HBD_MAX_RATE_22_5                 (0x0C)
128 
129 /* Host Based Discovery Action Reply Message */
130 typedef struct _MPI2_HBD_ACTION_REPLY
131 {
132     U8                      Operation;          /* 0x00 */
133     U8                      Reserved1;          /* 0x01 */
134     U8                      MsgLength;          /* 0x02 */
135     U8                      Function;           /* 0x03 */
136     U16                     DevHandle;          /* 0x04 */
137     U8                      Reserved2;          /* 0x06 */
138     U8                      MsgFlags;           /* 0x07 */
139     U8                      VP_ID;              /* 0x08 */
140     U8                      VF_ID;              /* 0x09 */
141     U16                     Reserved3;          /* 0x0A */
142     U16                     Reserved4;          /* 0x0C */
143     U16                     IOCStatus;          /* 0x0E */
144     U32                     IOCLogInfo;         /* 0x10 */
145 } MPI2_HBD_ACTION_REPLY, MPI2_POINTER PTR_MPI2_HBD_ACTION_REPLY,
146   Mpi2HbdActionReply_t, MPI2_POINTER pMpi2HbdActionReply_t;
147 
148 #endif
149