xref: /freebsd/sys/dev/mps/mpi/mpi2_hbd.h (revision 3c4ba5f55438f7afd4f4b0b56f88f2bb505fd6a6)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (c) 2009-2015 LSI Corp.
5  * Copyright (c) 2013-2015 Avago Technologies
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  *
29  * Avago Technologies (LSI) MPT-Fusion Host Adapter FreeBSD
30  *
31  * $FreeBSD$
32  */
33 
34 /*
35  *  Copyright (c) 2009-2015 LSI Corporation.
36  *  Copyright (c) 2013-2015 Avago Technologies
37  *
38  *
39  *           Name:  mpi2_hbd.h
40  *          Title:  MPI Host Based Discovery messages and structures
41  *  Creation Date:  October 21, 2009
42  *
43  *  mpi2_hbd.h Version:  02.00.01
44  *
45  *  Version History
46  *  ---------------
47  *
48  *  Date      Version   Description
49  *  --------  --------  ------------------------------------------------------
50  *  10-28-09  02.00.00  Initial version.
51  *  08-11-10  02.00.01  Removed PortGroups, DmaGroup, and ControlGroup from
52  *                      HBD Action request, replaced by AdditionalInfo field.
53  *  --------------------------------------------------------------------------
54  */
55 
56 #ifndef MPI2_HBD_H
57 #define MPI2_HBD_H
58 
59 /****************************************************************************
60 *  Host Based Discovery Action messages
61 ****************************************************************************/
62 
63 /* Host Based Discovery Action Request Message */
64 typedef struct _MPI2_HBD_ACTION_REQUEST
65 {
66     U8                      Operation;          /* 0x00 */
67     U8                      Reserved1;          /* 0x01 */
68     U8                      ChainOffset;        /* 0x02 */
69     U8                      Function;           /* 0x03 */
70     U16                     DevHandle;          /* 0x04 */
71     U8                      Reserved2;          /* 0x06 */
72     U8                      MsgFlags;           /* 0x07 */
73     U8                      VP_ID;              /* 0x08 */
74     U8                      VF_ID;              /* 0x09 */
75     U16                     Reserved3;          /* 0x0A */
76     U32                     Reserved4;          /* 0x0C */
77     U64                     SASAddress;         /* 0x10 */
78     U32                     Reserved5;          /* 0x18 */
79     U32                     HbdDeviceInfo;      /* 0x1C */
80     U16                     ParentDevHandle;    /* 0x20 */
81     U16                     MaxQDepth;          /* 0x22 */
82     U8                      FirstPhyIdentifier; /* 0x24 */
83     U8                      Port;               /* 0x25 */
84     U8                      MaxConnections;     /* 0x26 */
85     U8                      MaxRate;            /* 0x27 */
86     U32                     AdditionalInfo;     /* 0x28 */
87     U16                     InitialAWT;         /* 0x2C */
88     U16                     Reserved7;          /* 0x2E */
89     U32                     Reserved8;          /* 0x30 */
90 } MPI2_HBD_ACTION_REQUEST, MPI2_POINTER PTR_MPI2_HBD_ACTION_REQUEST,
91   Mpi2HbdActionRequest_t, MPI2_POINTER pMpi2HbdActionRequest_t;
92 
93 /* values for the Operation field */
94 #define MPI2_HBD_OP_ADD_DEVICE                  (0x01)
95 #define MPI2_HBD_OP_REMOVE_DEVICE               (0x02)
96 #define MPI2_HBD_OP_UPDATE_DEVICE               (0x03)
97 
98 /* values for the HbdDeviceInfo field */
99 #define MPI2_HBD_DEVICE_INFO_VIRTUAL_DEVICE     (0x00004000)
100 #define MPI2_HBD_DEVICE_INFO_ATAPI_DEVICE       (0x00002000)
101 #define MPI2_HBD_DEVICE_INFO_DIRECT_ATTACH      (0x00000800)
102 #define MPI2_HBD_DEVICE_INFO_SSP_TARGET         (0x00000400)
103 #define MPI2_HBD_DEVICE_INFO_STP_TARGET         (0x00000200)
104 #define MPI2_HBD_DEVICE_INFO_SMP_TARGET         (0x00000100)
105 #define MPI2_HBD_DEVICE_INFO_SATA_DEVICE        (0x00000080)
106 #define MPI2_HBD_DEVICE_INFO_SSP_INITIATOR      (0x00000040)
107 #define MPI2_HBD_DEVICE_INFO_STP_INITIATOR      (0x00000020)
108 #define MPI2_HBD_DEVICE_INFO_SMP_INITIATOR      (0x00000010)
109 #define MPI2_HBD_DEVICE_INFO_SATA_HOST          (0x00000008)
110 
111 #define MPI2_HBD_DEVICE_INFO_MASK_DEVICE_TYPE   (0x00000007)
112 #define MPI2_HBD_DEVICE_INFO_NO_DEVICE          (0x00000000)
113 #define MPI2_HBD_DEVICE_INFO_END_DEVICE         (0x00000001)
114 #define MPI2_HBD_DEVICE_INFO_EDGE_EXPANDER      (0x00000002)
115 #define MPI2_HBD_DEVICE_INFO_FANOUT_EXPANDER    (0x00000003)
116 
117 /* values for the MaxRate field */
118 #define MPI2_HBD_MAX_RATE_MASK                  (0x0F)
119 #define MPI2_HBD_MAX_RATE_1_5                   (0x08)
120 #define MPI2_HBD_MAX_RATE_3_0                   (0x09)
121 #define MPI2_HBD_MAX_RATE_6_0                   (0x0A)
122 
123 /* Host Based Discovery Action Reply Message */
124 typedef struct _MPI2_HBD_ACTION_REPLY
125 {
126     U8                      Operation;          /* 0x00 */
127     U8                      Reserved1;          /* 0x01 */
128     U8                      MsgLength;          /* 0x02 */
129     U8                      Function;           /* 0x03 */
130     U16                     DevHandle;          /* 0x04 */
131     U8                      Reserved2;          /* 0x06 */
132     U8                      MsgFlags;           /* 0x07 */
133     U8                      VP_ID;              /* 0x08 */
134     U8                      VF_ID;              /* 0x09 */
135     U16                     Reserved3;          /* 0x0A */
136     U16                     Reserved4;          /* 0x0C */
137     U16                     IOCStatus;          /* 0x0E */
138     U32                     IOCLogInfo;         /* 0x10 */
139 } MPI2_HBD_ACTION_REPLY, MPI2_POINTER PTR_MPI2_HBD_ACTION_REPLY,
140   Mpi2HbdActionReply_t, MPI2_POINTER pMpi2HbdActionReply_t;
141 
142 #endif
143