xref: /freebsd/sys/dev/mpi3mr/mpi/mpi30_sas.h (revision baabb919345f05e9892c4048a1521e5da1403060)
1  /*
2   * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3   *
4   * Copyright (c) 2016-2024, Broadcom Inc. All rights reserved.
5   * Support: <fbsd-storage-driver.pdl@broadcom.com>
6   *
7   * Redistribution and use in source and binary forms, with or without
8   * modification, are permitted provided that the following conditions are
9   * met:
10   *
11   * 1. Redistributions of source code must retain the above copyright notice,
12   *    this list of conditions and the following disclaimer.
13   * 2. Redistributions in binary form must reproduce the above copyright notice,
14   *    this list of conditions and the following disclaimer in the documentation and/or other
15   *    materials provided with the distribution.
16   * 3. Neither the name of the Broadcom Inc. nor the names of its contributors
17   *    may be used to endorse or promote products derived from this software without
18   *    specific prior written permission.
19   *
20   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23   * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
24   * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25   * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26   * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27   * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28   * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30   * POSSIBILITY OF SUCH DAMAGE.
31   *
32   * The views and conclusions contained in the software and documentation are
33   * those of the authors and should not be interpreted as representing
34   * official policies,either expressed or implied, of the FreeBSD Project.
35   *
36   * Mail to: Broadcom Inc 1320 Ridder Park Dr, San Jose, CA 95131
37   *
38   * Broadcom Inc. (Broadcom) MPI3MR Adapter FreeBSD
39   *
40   */
41  #ifndef MPI30_SAS_H
42  #define MPI30_SAS_H     1
43  
44  /*****************************************************************************
45   *              SAS Device Info Definitions                                  *
46   ****************************************************************************/
47  #define MPI3_SAS_DEVICE_INFO_SSP_TARGET             (0x00000100)
48  #define MPI3_SAS_DEVICE_INFO_STP_SATA_TARGET        (0x00000080)
49  #define MPI3_SAS_DEVICE_INFO_SMP_TARGET             (0x00000040)
50  #define MPI3_SAS_DEVICE_INFO_SSP_INITIATOR          (0x00000020)
51  #define MPI3_SAS_DEVICE_INFO_STP_INITIATOR          (0x00000010)
52  #define MPI3_SAS_DEVICE_INFO_SMP_INITIATOR          (0x00000008)
53  #define MPI3_SAS_DEVICE_INFO_DEVICE_TYPE_MASK       (0x00000007)
54  #define MPI3_SAS_DEVICE_INFO_DEVICE_TYPE_NO_DEVICE  (0x00000000)
55  #define MPI3_SAS_DEVICE_INFO_DEVICE_TYPE_END_DEVICE (0x00000001)
56  #define MPI3_SAS_DEVICE_INFO_DEVICE_TYPE_EXPANDER   (0x00000002)
57  
58  /*****************************************************************************
59   *              SMP Passthrough Request Message                              *
60   ****************************************************************************/
61  typedef struct _MPI3_SMP_PASSTHROUGH_REQUEST
62  {
63      U16                     HostTag;                        /* 0x00 */
64      U8                      IOCUseOnly02;                   /* 0x02 */
65      U8                      Function;                       /* 0x03 */
66      U16                     IOCUseOnly04;                   /* 0x04 */
67      U8                      IOCUseOnly06;                   /* 0x06 */
68      U8                      MsgFlags;                       /* 0x07 */
69      U16                     ChangeCount;                    /* 0x08 */
70      U8                      Reserved0A;                     /* 0x0A */
71      U8                      IOUnitPort;                     /* 0x0B */
72      U32                     Reserved0C[3];                  /* 0x0C */
73      U64                     SASAddress;                     /* 0x18 */
74      MPI3_SGE_SIMPLE         RequestSGE;                     /* 0x20 */
75      MPI3_SGE_SIMPLE         ResponseSGE;                    /* 0x30 */
76  } MPI3_SMP_PASSTHROUGH_REQUEST, MPI3_POINTER PTR_MPI3_SMP_PASSTHROUGH_REQUEST,
77    Mpi3SmpPassthroughRequest_t, MPI3_POINTER pMpi3SmpPassthroughRequest_t;
78  
79  /*****************************************************************************
80   *              SMP Passthrough Reply Message                               *
81   ****************************************************************************/
82  typedef struct _MPI3_SMP_PASSTHROUGH_REPLY
83  {
84      U16                     HostTag;                        /* 0x00 */
85      U8                      IOCUseOnly02;                   /* 0x02 */
86      U8                      Function;                       /* 0x03 */
87      U16                     IOCUseOnly04;                   /* 0x04 */
88      U8                      IOCUseOnly06;                   /* 0x06 */
89      U8                      MsgFlags;                       /* 0x07 */
90      U16                     IOCUseOnly08;                   /* 0x08 */
91      U16                     IOCStatus;                      /* 0x0A */
92      U32                     IOCLogInfo;                     /* 0x0C */
93      U16                     ResponseDataLength;             /* 0x10 */
94      U16                     Reserved12;                     /* 0x12 */
95  } MPI3_SMP_PASSTHROUGH_REPLY, MPI3_POINTER PTR_MPI3_SMP_PASSTHROUGH_REPLY,
96    Mpi3SmpPassthroughReply_t, MPI3_POINTER pMpi3SmpPassthroughReply_t;
97  
98  #endif  /* MPI30_SAS_H */
99