xref: /freebsd/sys/dev/mps/mpi/mpi2_hbd.h (revision 9a14aa017b21c292740c00ee098195cd46642730)
1 /* $FreeBSD$ */
2 /*
3  *  Copyright (c) 2009 LSI Corporation.
4  *
5  *
6  *           Name:  mpi2_hbd.h
7  *          Title:  MPI Host Based Discovery messages and structures
8  *  Creation Date:  October 21, 2009
9  *
10  *  mpi2_hbd.h Version:  02.00.00
11  *
12  *  Version History
13  *  ---------------
14  *
15  *  Date      Version   Description
16  *  --------  --------  ------------------------------------------------------
17  *  10-28-09  02.00.00  Initial version.
18  *  --------------------------------------------------------------------------
19  */
20 
21 #ifndef MPI2_HBD_H
22 #define MPI2_HBD_H
23 
24 /****************************************************************************
25 *  Host Based Discovery Action messages
26 ****************************************************************************/
27 
28 /* Host Based Discovery Action Request Message */
29 typedef struct _MPI2_HBD_ACTION_REQUEST
30 {
31     U8                      Operation;          /* 0x00 */
32     U8                      Reserved1;          /* 0x01 */
33     U8                      ChainOffset;        /* 0x02 */
34     U8                      Function;           /* 0x03 */
35     U16                     DevHandle;          /* 0x04 */
36     U8                      Reserved2;          /* 0x06 */
37     U8                      MsgFlags;           /* 0x07 */
38     U8                      VP_ID;              /* 0x08 */
39     U8                      VF_ID;              /* 0x09 */
40     U16                     Reserved3;          /* 0x0A */
41     U32                     Reserved4;          /* 0x0C */
42     U64                     SASAddress;         /* 0x10 */
43     U32                     Reserved5;          /* 0x18 */
44     U32                     HbdDeviceInfo;      /* 0x1C */
45     U16                     ParentDevHandle;    /* 0x20 */
46     U16                     MaxQDepth;          /* 0x22 */
47     U8                      FirstPhyIdentifier; /* 0x24 */
48     U8                      Port;               /* 0x25 */
49     U8                      MaxConnections;     /* 0x26 */
50     U8                      MaxRate;            /* 0x27 */
51     U8                      PortGroups;         /* 0x28 */
52     U8                      DmaGroup;           /* 0x29 */
53     U8                      ControlGroup;       /* 0x2A */
54     U8                      Reserved6;          /* 0x2B */
55     U16                     InitialAWT;         /* 0x2C */
56     U16                     Reserved7;          /* 0x2E */
57     U32                     Reserved8;          /* 0x30 */
58 } MPI2_HBD_ACTION_REQUEST, MPI2_POINTER PTR_MPI2_HBD_ACTION_REQUEST,
59   Mpi2HbdActionRequest_t, MPI2_POINTER pMpi2HbdActionRequest_t;
60 
61 /* values for the Operation field */
62 #define MPI2_HBD_OP_ADD_DEVICE                  (0x01)
63 #define MPI2_HBD_OP_REMOVE_DEVICE               (0x02)
64 #define MPI2_HBD_OP_UPDATE_DEVICE               (0x03)
65 
66 /* values for the HbdDeviceInfo field */
67 #define MPI2_HBD_DEVICE_INFO_VIRTUAL_DEVICE     (0x00004000)
68 #define MPI2_HBD_DEVICE_INFO_ATAPI_DEVICE       (0x00002000)
69 #define MPI2_HBD_DEVICE_INFO_DIRECT_ATTACH      (0x00000800)
70 #define MPI2_HBD_DEVICE_INFO_SSP_TARGET         (0x00000400)
71 #define MPI2_HBD_DEVICE_INFO_STP_TARGET         (0x00000200)
72 #define MPI2_HBD_DEVICE_INFO_SMP_TARGET         (0x00000100)
73 #define MPI2_HBD_DEVICE_INFO_SATA_DEVICE        (0x00000080)
74 #define MPI2_HBD_DEVICE_INFO_SSP_INITIATOR      (0x00000040)
75 #define MPI2_HBD_DEVICE_INFO_STP_INITIATOR      (0x00000020)
76 #define MPI2_HBD_DEVICE_INFO_SMP_INITIATOR      (0x00000010)
77 #define MPI2_HBD_DEVICE_INFO_SATA_HOST          (0x00000008)
78 
79 #define MPI2_HBD_DEVICE_INFO_MASK_DEVICE_TYPE   (0x00000007)
80 #define MPI2_HBD_DEVICE_INFO_NO_DEVICE          (0x00000000)
81 #define MPI2_HBD_DEVICE_INFO_END_DEVICE         (0x00000001)
82 #define MPI2_HBD_DEVICE_INFO_EDGE_EXPANDER      (0x00000002)
83 #define MPI2_HBD_DEVICE_INFO_FANOUT_EXPANDER    (0x00000003)
84 
85 /* values for the MaxRate field */
86 #define MPI2_HBD_MAX_RATE_MASK                  (0x0F)
87 #define MPI2_HBD_MAX_RATE_1_5                   (0x08)
88 #define MPI2_HBD_MAX_RATE_3_0                   (0x09)
89 #define MPI2_HBD_MAX_RATE_6_0                   (0x0A)
90 
91 
92 /* Host Based Discovery Action Reply Message */
93 typedef struct _MPI2_HBD_ACTION_REPLY
94 {
95     U8                      Operation;          /* 0x00 */
96     U8                      Reserved1;          /* 0x01 */
97     U8                      MsgLength;          /* 0x02 */
98     U8                      Function;           /* 0x03 */
99     U16                     DevHandle;          /* 0x04 */
100     U8                      Reserved2;          /* 0x06 */
101     U8                      MsgFlags;           /* 0x07 */
102     U8                      VP_ID;              /* 0x08 */
103     U8                      VF_ID;              /* 0x09 */
104     U16                     Reserved3;          /* 0x0A */
105     U16                     Reserved4;          /* 0x0C */
106     U16                     IOCStatus;          /* 0x0E */
107     U32                     IOCLogInfo;         /* 0x10 */
108 } MPI2_HBD_ACTION_REPLY, MPI2_POINTER PTR_MPI2_HBD_ACTION_REPLY,
109   Mpi2HbdActionReply_t, MPI2_POINTER pMpi2HbdActionReply_t;
110 
111 
112 #endif
113 
114 
115