xref: /freebsd/sys/dev/mpt/mpilib/mpi_log_sas.h (revision f0a75d274af375d15b97b830966b99a02b7db911)
1 /* $FreeBSD$ */
2 /*-
3  * Copyright (c) 2000-2005, LSI Logic Corporation and its contributors.
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 are
8  * 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 at minimum a disclaimer
12  *    substantially similar to the "NO WARRANTY" disclaimer below
13  *    ("Disclaimer") and any redistribution must be conditioned upon including
14  *    a substantially similar Disclaimer requirement for further binary
15  *    redistribution.
16  * 3. Neither the name of the LSI Logic Corporation nor the names of its
17  *    contributors may be used to endorse or promote products derived from
18  *    this software without 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 OWNER 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 THE COPYRIGHT
30  * OWNER OR CONTRIBUTOR IS ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  *                                                                         *
32  ***************************************************************************
33  *
34  *           Name:  iopiIocLogInfo.h
35  *          Title:  SAS Firmware IOP Interface IOC Log Info Definitions
36  *     Programmer:  Guy Kendall
37  *  Creation Date:  September 24, 2003
38  *
39  *  Version History
40  *  ---------------
41  *
42  *  Last Updated
43  *  -------------
44  *  Version         %version: 22 %
45  *  Date Updated    %date_modified: %
46  *  Programmer      %created_by: nperucca %
47  *
48  *  Date      Who   Description
49  *  --------  ---   -------------------------------------------------------
50  *  09/24/03  GWK   Initial version
51  *
52  *
53  * Description
54  * ------------
55  * This include file contains SAS firmware interface IOC Log Info codes
56  *
57  *-------------------------------------------------------------------------
58  */
59 
60 #ifndef IOPI_IOCLOGINFO_H_INCLUDED
61 #define IOPI_IOCLOGINFO_H_INCLUDED
62 
63 
64 /****************************************************************************/
65 /*  IOC LOGINFO defines, 0x00000000 - 0x0FFFFFFF                            */
66 /*  Format:                                                                 */
67 /*      Bits 31-28: MPI_IOCLOGINFO_TYPE_SAS (3)                             */
68 /*      Bits 27-24: IOC_LOGINFO_ORIGINATOR: 0=IOP, 1=PL, 2=IR               */
69 /*      Bits 23-16: LOGINFO_CODE                                            */
70 /*      Bits 15-0:  LOGINFO_CODE Specific                                   */
71 /****************************************************************************/
72 
73 /****************************************************************************/
74 /* IOC_LOGINFO_ORIGINATOR defines                                           */
75 /****************************************************************************/
76 #define IOC_LOGINFO_ORIGINATOR_IOP                      (0x00000000)
77 #define IOC_LOGINFO_ORIGINATOR_PL                       (0x01000000)
78 #define IOC_LOGINFO_ORIGINATOR_IR                       (0x02000000)
79 
80 /****************************************************************************/
81 /* LOGINFO_CODE defines                                                     */
82 /****************************************************************************/
83 #define IOC_LOGINFO_CODE_MASK                           (0x00FF0000)
84 #define IOC_LOGINFO_CODE_SHIFT                          (16)
85 
86 /****************************************************************************/
87 /* IOP LOGINFO_CODE defines, valid if IOC_LOGINFO_ORIGINATOR = IOP          */
88 /****************************************************************************/
89 #define IOP_LOGINFO_CODE_INVALID_SAS_ADDRESS            (0x00010000)
90 #define IOP_LOGINFO_CODE_UNUSED2                        (0x00020000)
91 #define IOP_LOGINFO_CODE_CONFIG_INVALID_PAGE            (0x00030000)
92 #define IOP_LOGINFO_CODE_CONFIG_INVALID_PAGE_RT         (0x00030100) /* Route Table Entry not found */
93 #define IOP_LOGINFO_CODE_CONFIG_INVALID_PAGE_PN         (0x00030200) /* Invalid Page Number */
94 #define IOP_LOGINFO_CODE_CONFIG_INVALID_PAGE_FORM       (0x00030300) /* Invalid FORM */
95 #define IOP_LOGINFO_CODE_CONFIG_INVALID_PAGE_PT         (0x00030400) /* Invalid Page Type */
96 #define IOP_LOGINFO_CODE_CONFIG_INVALID_PAGE_DNM        (0x00030500) /* Device Not Mapped */
97 #define IOP_LOGINFO_CODE_CONFIG_INVALID_PAGE_PERSIST    (0x00030600) /* Persistent Page not found */
98 #define IOP_LOGINFO_CODE_CONFIG_INVALID_PAGE_DEFAULT    (0x00030700) /* Default Page not found */
99 #define IOP_LOGINFO_CODE_TASK_TERMINATED                (0x00050000)
100 
101 
102 /****************************************************************************/
103 /* PL LOGINFO_CODE defines, valid if IOC_LOGINFO_ORIGINATOR = PL            */
104 /****************************************************************************/
105 #define PL_LOGINFO_CODE_OPEN_FAILURE                        (0x00010000)
106 #define PL_LOGINFO_CODE_INVALID_SGL                         (0x00020000)
107 #define PL_LOGINFO_CODE_WRONG_REL_OFF_OR_FRAME_LENGTH       (0x00030000)
108 #define PL_LOGINFO_CODE_FRAME_XFER_ERROR                    (0x00040000)
109 #define PL_LOGINFO_CODE_TX_FM_CONNECTED_LOW                 (0x00050000)
110 #define PL_LOGINFO_CODE_SATA_NON_NCQ_RW_ERR_BIT_SET         (0x00060000)
111 #define PL_LOGINFO_CODE_SATA_READ_LOG_RECEIVE_DATA_ERR      (0x00070000)
112 #define PL_LOGINFO_CODE_SATA_NCQ_FAIL_ALL_CMDS_AFTR_ERR     (0x00080000)
113 #define PL_LOGINFO_CODE_SATA_ERR_IN_RCV_SET_DEV_BIT_FIS     (0x00090000)
114 #define PL_LOGINFO_CODE_RX_FM_INVALID_MESSAGE               (0x000A0000)
115 #define PL_LOGINFO_CODE_RX_CTX_MESSAGE_VALID_ERROR          (0x000B0000)
116 #define PL_LOGINFO_CODE_RX_FM_CURRENT_FRAME_ERROR           (0x000C0000)
117 #define PL_LOGINFO_CODE_SATA_LINK_DOWN                      (0x000D0000)
118 #define PL_LOGINFO_CODE_DISCOVERY_SATA_INIT_W_IOS           (0x000E0000)
119 #define PL_LOGINFO_CODE_CONFIG_INVALID_PAGE                 (0x000F0000)
120 #define PL_LOGINFO_CODE_CONFIG_INVALID_PAGE_PT              (0x000F0100) /* Invalid Page Type */
121 #define PL_LOGINFO_CODE_CONFIG_INVALID_PAGE_NUM_PHYS        (0x000F0200) /* Invalid Number of Phys */
122 #define PL_LOGINFO_CODE_CONFIG_INVALID_PAGE_NOT_IMP         (0x000F0300) /* Case Not Handled */
123 #define PL_LOGINFO_CODE_CONFIG_INVALID_PAGE_NO_DEV          (0x000F0400) /* No Device Found */
124 #define PL_LOGINFO_CODE_CONFIG_INVALID_PAGE_FORM            (0x000F0500) /* Invalid FORM */
125 #define PL_LOGINFO_CODE_CONFIG_INVALID_PAGE_PHY             (0x000F0600) /* Invalid Phy */
126 #define PL_LOGINFO_CODE_CONFIG_INVALID_PAGE_NO_OWNER        (0x000F0700) /* No Owner Found */
127 #define PL_LOGINFO_CODE_DSCVRY_SATA_INIT_TIMEOUT            (0x00100000)
128 #define PL_LOGINFO_CODE_RESET                               (0x00110000)
129 #define PL_LOGINFO_CODE_ABORT                               (0x00120000)
130 #define PL_LOGINFO_CODE_IO_NOT_YET_EXECUTED                 (0x00130000)
131 #define PL_LOGINFO_CODE_IO_EXECUTED                         (0x00140000)
132 #define PL_LOGINFO_SUB_CODE_OPEN_FAILURE                    (0x00000100)
133 #define PL_LOGINFO_SUB_CODE_INVALID_SGL                     (0x00000200)
134 #define PL_LOGINFO_SUB_CODE_WRONG_REL_OFF_OR_FRAME_LENGTH   (0x00000300)
135 #define PL_LOGINFO_SUB_CODE_FRAME_XFER_ERROR                (0x00000400)
136 #define PL_LOGINFO_SUB_CODE_TX_FM_CONNECTED_LOW             (0x00000500)
137 #define PL_LOGINFO_SUB_CODE_SATA_NON_NCQ_RW_ERR_BIT_SET     (0x00000600)
138 #define PL_LOGINFO_SUB_CODE_SATA_READ_LOG_RECEIVE_DATA_ERR  (0x00000700)
139 #define PL_LOGINFO_SUB_CODE_SATA_NCQ_FAIL_ALL_CMDS_AFTR_ERR (0x00000800)
140 #define PL_LOGINFO_SUB_CODE_SATA_ERR_IN_RCV_SET_DEV_BIT_FIS (0x00000900)
141 #define PL_LOGINFO_SUB_CODE_RX_FM_INVALID_MESSAGE           (0x00000A00)
142 #define PL_LOGINFO_SUB_CODE_RX_CTX_MESSAGE_VALID_ERROR      (0x00000B00)
143 #define PL_LOGINFO_SUB_CODE_RX_FM_CURRENT_FRAME_ERROR       (0x00000C00)
144 #define PL_LOGINFO_SUB_CODE_SATA_LINK_DOWN                  (0x00000D00)
145 #define PL_LOGINFO_SUB_CODE_DISCOVERY_SATA_INIT_W_IOS       (0x00000E00)
146 #define PL_LOGINFO_SUB_CODE_DSCVRY_SATA_INIT_TIMEOUT        (0x00001000)
147 
148 
149 #define PL_LOGINFO_CODE_ENCL_MGMT_SMP_FRAME_FAILURE         (0x00200000) /* Can't get SMP Frame */
150 #define PL_LOGINFO_CODE_ENCL_MGMT_SMP_READ_ERROR            (0x00200001) /* Error occured on SMP Read */
151 #define PL_LOGINFO_CODE_ENCL_MGMT_SMP_WRITE_ERROR           (0x00200002) /* Error occured on SMP Write */
152 #define PL_LOGINFO_CODE_ENCL_MGMT_NOT_SUPPORTED_ON_ENCL     (0x00200004) /* Encl Mgmt services not available for this WWID */
153 #define PL_LOGINFO_CODE_ENCL_MGMT_ADDR_MODE_NOT_SUPPORTED   (0x00200005) /* Address Mode not suppored */
154 #define PL_LOGINFO_CODE_ENCL_MGMT_BAD_SLOT_NUM              (0x00200006) /* Invalid Slot Number in SEP Msg */
155 #define PL_LOGINFO_CODE_ENCL_MGMT_SGPIO_NOT_PRESENT         (0x00200007) /* SGPIO not present/enabled */
156 
157 #define PL_LOGINFO_DA_SEP_NOT_PRESENT                       (0x00200100) /* SEP not present when msg received */
158 #define PL_LOGINFO_DA_SEP_SINGLE_THREAD_ERROR               (0x00200101) /* Can only accept 1 msg at a time */
159 #define PL_LOGINFO_DA_SEP_ISTWI_INTR_IN_IDLE_STATE          (0x00200102) /* ISTWI interrupt recvd. while IDLE */
160 #define PL_LOGINFO_DA_SEP_RECEIVED_NACK_FROM_SLAVE          (0x00200103) /* SEP NACK'd, it is busy */
161 #define PL_LOGINFO_DA_SEP_BAD_STATUS_HDR_CHKSUM             (0x00200104) /* SEP stopped or sent bad chksum in Hdr */
162 #define PL_LOGINFO_DA_SEP_UNSUPPORTED_SCSI_STATUS_1         (0x00200105) /* SEP returned unknown scsi status */
163 #define PL_LOGINFO_DA_SEP_UNSUPPORTED_SCSI_STATUS_2         (0x00200106) /* SEP returned unknown scsi status */
164 #define PL_LOGINFO_DA_SEP_CHKSUM_ERROR_AFTER_STOP           (0x00200107) /* SEP returned bad chksum after STOP */
165 #define PL_LOGINFO_DA_SEP_CHKSUM_ERROR_AFTER_STOP_GETDATA   (0x00200108) /* SEP returned bad chksum after STOP while gettin data*/
166 
167 
168 /****************************************************************************/
169 /* IR LOGINFO_CODE defines, valid if IOC_LOGINFO_ORIGINATOR = IR            */
170 /****************************************************************************/
171 #define IR_LOGINFO_CODE_UNUSED1                         (0x00010000)
172 #define IR_LOGINFO_CODE_UNUSED2                         (0x00020000)
173 
174 /****************************************************************************/
175 /* Defines for convienence                                                  */
176 /****************************************************************************/
177 #define IOC_LOGINFO_PREFIX_IOP                          ((MPI_IOCLOGINFO_TYPE_SAS << MPI_IOCLOGINFO_TYPE_SHIFT) | IOC_LOGINFO_ORIGINATOR_IOP)
178 #define IOC_LOGINFO_PREFIX_PL                           ((MPI_IOCLOGINFO_TYPE_SAS << MPI_IOCLOGINFO_TYPE_SHIFT) | IOC_LOGINFO_ORIGINATOR_PL)
179 #define IOC_LOGINFO_PREFIX_IR                           ((MPI_IOCLOGINFO_TYPE_SAS << MPI_IOCLOGINFO_TYPE_SHIFT) | IOC_LOGINFO_ORIGINATOR_IR)
180 
181 #endif /* end of file */
182