2 * Copyright (c) 2012-2015 LSI Corp.
3 * Copyright (c) 2013-2016 Avago Technologies
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
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.
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
30 * Avago Technologies (LSI) MPT-Fusion Host Adapter FreeBSD
32 * $FreeBSD: head/sys/dev/mpr/mpi/mpi2_hbd.h 318427 2017-05-17 21:33:37Z slm $
36 * Copyright (c) 2009-2015 LSI Corporation.
37 * Copyright (c) 2013-2016 Avago Technologies
38 * All rights reserved.
42 * Title: MPI Host Based Discovery messages and structures
43 * Creation Date: October 21, 2009
45 * mpi2_hbd.h Version: 02.00.04
47 * NOTE: Names (typedefs, defines, etc.) beginning with an MPI25 or Mpi25
48 * prefix are for use only on MPI v2.5 products, and must not be used
49 * with MPI v2.0 products. Unless otherwise noted, names beginning with
50 * MPI2 or Mpi2 are for use with both MPI v2.0 and MPI v2.5 products.
55 * Date Version Description
56 * -------- -------- ------------------------------------------------------
57 * 10-28-09 02.00.00 Initial version.
58 * 08-11-10 02.00.01 Removed PortGroups, DmaGroup, and ControlGroup from
59 * HBD Action request, replaced by AdditionalInfo field.
60 * 11-18-11 02.00.02 Incorporating additions for MPI v2.5.
61 * 11-18-14 02.00.03 Updated copyright information.
62 * 02-17-16 02.00.04 Added SAS 4 22.5 gbs speed support.
63 * --------------------------------------------------------------------------
69 /****************************************************************************
70 * Host Based Discovery Action messages
71 ****************************************************************************/
73 /* Host Based Discovery Action Request Message */
74 typedef struct _MPI2_HBD_ACTION_REQUEST
76 U8 Operation; /* 0x00 */
77 U8 Reserved1; /* 0x01 */
78 U8 ChainOffset; /* 0x02 */
79 U8 Function; /* 0x03 */
80 U16 DevHandle; /* 0x04 */
81 U8 Reserved2; /* 0x06 */
82 U8 MsgFlags; /* 0x07 */
85 U16 Reserved3; /* 0x0A */
86 U32 Reserved4; /* 0x0C */
87 U64 SASAddress; /* 0x10 */
88 U32 Reserved5; /* 0x18 */
89 U32 HbdDeviceInfo; /* 0x1C */
90 U16 ParentDevHandle; /* 0x20 */
91 U16 MaxQDepth; /* 0x22 */
92 U8 FirstPhyIdentifier; /* 0x24 */
94 U8 MaxConnections; /* 0x26 */
95 U8 MaxRate; /* 0x27 */
96 U32 AdditionalInfo; /* 0x28 */
97 U16 InitialAWT; /* 0x2C */
98 U16 Reserved7; /* 0x2E */
99 U32 Reserved8; /* 0x30 */
100 } MPI2_HBD_ACTION_REQUEST, MPI2_POINTER PTR_MPI2_HBD_ACTION_REQUEST,
101 Mpi2HbdActionRequest_t, MPI2_POINTER pMpi2HbdActionRequest_t;
103 /* values for the Operation field */
104 #define MPI2_HBD_OP_ADD_DEVICE (0x01)
105 #define MPI2_HBD_OP_REMOVE_DEVICE (0x02)
106 #define MPI2_HBD_OP_UPDATE_DEVICE (0x03)
108 /* values for the HbdDeviceInfo field */
109 #define MPI2_HBD_DEVICE_INFO_VIRTUAL_DEVICE (0x00004000)
110 #define MPI2_HBD_DEVICE_INFO_ATAPI_DEVICE (0x00002000)
111 #define MPI2_HBD_DEVICE_INFO_DIRECT_ATTACH (0x00000800)
112 #define MPI2_HBD_DEVICE_INFO_SSP_TARGET (0x00000400)
113 #define MPI2_HBD_DEVICE_INFO_STP_TARGET (0x00000200)
114 #define MPI2_HBD_DEVICE_INFO_SMP_TARGET (0x00000100)
115 #define MPI2_HBD_DEVICE_INFO_SATA_DEVICE (0x00000080)
116 #define MPI2_HBD_DEVICE_INFO_SSP_INITIATOR (0x00000040)
117 #define MPI2_HBD_DEVICE_INFO_STP_INITIATOR (0x00000020)
118 #define MPI2_HBD_DEVICE_INFO_SMP_INITIATOR (0x00000010)
119 #define MPI2_HBD_DEVICE_INFO_SATA_HOST (0x00000008)
121 #define MPI2_HBD_DEVICE_INFO_MASK_DEVICE_TYPE (0x00000007)
122 #define MPI2_HBD_DEVICE_INFO_NO_DEVICE (0x00000000)
123 #define MPI2_HBD_DEVICE_INFO_END_DEVICE (0x00000001)
124 #define MPI2_HBD_DEVICE_INFO_EDGE_EXPANDER (0x00000002)
125 #define MPI2_HBD_DEVICE_INFO_FANOUT_EXPANDER (0x00000003)
127 /* values for the MaxRate field */
128 #define MPI2_HBD_MAX_RATE_MASK (0x0F)
129 #define MPI2_HBD_MAX_RATE_1_5 (0x08)
130 #define MPI2_HBD_MAX_RATE_3_0 (0x09)
131 #define MPI2_HBD_MAX_RATE_6_0 (0x0A)
132 #define MPI25_HBD_MAX_RATE_12_0 (0x0B)
133 #define MPI26_HBD_MAX_RATE_22_5 (0x0C)
136 /* Host Based Discovery Action Reply Message */
137 typedef struct _MPI2_HBD_ACTION_REPLY
139 U8 Operation; /* 0x00 */
140 U8 Reserved1; /* 0x01 */
141 U8 MsgLength; /* 0x02 */
142 U8 Function; /* 0x03 */
143 U16 DevHandle; /* 0x04 */
144 U8 Reserved2; /* 0x06 */
145 U8 MsgFlags; /* 0x07 */
148 U16 Reserved3; /* 0x0A */
149 U16 Reserved4; /* 0x0C */
150 U16 IOCStatus; /* 0x0E */
151 U32 IOCLogInfo; /* 0x10 */
152 } MPI2_HBD_ACTION_REPLY, MPI2_POINTER PTR_MPI2_HBD_ACTION_REPLY,
153 Mpi2HbdActionReply_t, MPI2_POINTER pMpi2HbdActionReply_t;