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