1 /* Copyright 2012 STEC, Inc.
3 * This file is licensed under the terms of the 3-clause
4 * BSD License (http://opensource.org/licenses/BSD-3-Clause)
5 * or the GNU GPL-2.0 (http://www.gnu.org/licenses/gpl-2.0.html),
6 * at your option. Both licenses are also available in the LICENSE file
7 * distributed with this project. This file may not be copied, modified,
8 * or distributed except in accordance with those terms.
15 #pragma pack(push, s1120_h, 1)
18 * Q-channel, 64-bit r/w
20 #define FIT_Q_COMMAND 0x400u
21 #define FIT_QCMD_QID_MASK (0x3 << 1)
22 #define FIT_QCMD_QID0 (0x0 << 1)
23 #define FIT_QCMD_QID_NORMAL FIT_QCMD_QID0
24 #ifndef SKD_OMIT_FROM_SRC_DIST
25 #define FIT_QCMD_QID1 (0x1 << 1)
26 #define FIT_QCMD_QID2 (0x2 << 1)
27 #define FIT_QCMD_QID3 (0x3 << 1)
28 #endif /* SKD_OMIT_FROM_SRC_DIST */
29 #define FIT_QCMD_FLUSH_QUEUE (0ull) /* add QID */
30 #define FIT_QCMD_MSGSIZE_MASK (0x3 << 4)
31 #define FIT_QCMD_MSGSIZE_64 (0x0 << 4)
32 #define FIT_QCMD_MSGSIZE_128 (0x1 << 4)
33 #define FIT_QCMD_MSGSIZE_256 (0x2 << 4)
34 #define FIT_QCMD_MSGSIZE_512 (0x3 << 4)
35 #define FIT_QCMD_BASE_ADDRESS_MASK (0xFFFFFFFFFFFFFFC0ull)
41 #define FIT_CONTROL 0x500u
42 #ifndef SKD_OMIT_FROM_SRC_DIST
43 #define FIT_CR_HARD_RESET (1u << 0u)
44 #endif /* SKD_OMIT_FROM_SRC_DIST */
45 #define FIT_CR_SOFT_RESET (1u << 1u)
46 #ifndef SKD_OMIT_FROM_SRC_DIST
47 #define FIT_CR_DIS_TIMESTAMPS (1u << 6u)
48 #endif /* SKD_OMIT_FROM_SRC_DIST */
49 #define FIT_CR_ENABLE_INTERRUPTS (1u << 7u)
54 #define FIT_STATUS 0x510u
55 #define FIT_SR_DRIVE_STATE_MASK 0x000000FFu
56 #ifndef SKD_OMIT_FROM_SRC_DIST
57 #define FIT_SR_SIGNATURE (0xFF << 8)
58 #define FIT_SR_PIO_DMA (1 << 16)
59 #endif /* SKD_OMIT_FROM_SRC_DIST */
60 #define FIT_SR_DRIVE_OFFLINE 0x00
61 #define FIT_SR_DRIVE_INIT 0x01
62 /* #define FIT_SR_DRIVE_READY 0x02 */
63 #define FIT_SR_DRIVE_ONLINE 0x03
64 #define FIT_SR_DRIVE_BUSY 0x04
65 #define FIT_SR_DRIVE_FAULT 0x05
66 #define FIT_SR_DRIVE_DEGRADED 0x06
67 #define FIT_SR_PCIE_LINK_DOWN 0x07
68 #define FIT_SR_DRIVE_SOFT_RESET 0x08
69 #define FIT_SR_DRIVE_INIT_FAULT 0x09
70 #define FIT_SR_DRIVE_BUSY_SANITIZE 0x0A
71 #define FIT_SR_DRIVE_BUSY_ERASE 0x0B
72 #define FIT_SR_DRIVE_FW_BOOTING 0x0C
73 #define FIT_SR_DRIVE_NEED_FW_DOWNLOAD 0xFE
74 #define FIT_SR_DEVICE_MISSING 0xFF
75 #define FIT_SR__RESERVED 0xFFFFFF00u
77 #ifndef SKD_OMIT_FROM_SRC_DIST
79 * FIT_STATUS - Status register data definition
81 #define FIT_SR_STATE_MASK (0xFF << 0)
82 #define FIT_SR_SIGNATURE (0xFF << 8)
83 #define FIT_SR_PIO_DMA (1 << 16)
84 #endif /* SKD_OMIT_FROM_SRC_DIST */
88 * Interrupt status, 32-bit r/w1c (w1c ==> write 1 to clear)
90 #define FIT_INT_STATUS_HOST 0x520u
91 #define FIT_ISH_FW_STATE_CHANGE (1u << 0u)
92 #define FIT_ISH_COMPLETION_POSTED (1u << 1u)
93 #define FIT_ISH_MSG_FROM_DEV (1u << 2u)
94 #define FIT_ISH_UNDEFINED_3 (1u << 3u)
95 #define FIT_ISH_UNDEFINED_4 (1u << 4u)
96 #define FIT_ISH_Q0_FULL (1u << 5u)
97 #define FIT_ISH_Q1_FULL (1u << 6u)
98 #define FIT_ISH_Q2_FULL (1u << 7u)
99 #define FIT_ISH_Q3_FULL (1u << 8u)
100 #define FIT_ISH_QCMD_FIFO_OVERRUN (1u << 9u)
101 #define FIT_ISH_BAD_EXP_ROM_READ (1u << 10u)
104 #define FIT_INT_DEF_MASK \
105 (FIT_ISH_FW_STATE_CHANGE | \
106 FIT_ISH_COMPLETION_POSTED | \
107 FIT_ISH_MSG_FROM_DEV | \
112 FIT_ISH_QCMD_FIFO_OVERRUN | \
113 FIT_ISH_BAD_EXP_ROM_READ)
115 #define FIT_INT_QUEUE_FULL \
122 #define MSI_MSG_NWL_ERROR_0 0x00000000
123 #define MSI_MSG_NWL_ERROR_1 0x00000001
124 #define MSI_MSG_NWL_ERROR_2 0x00000002
125 #define MSI_MSG_NWL_ERROR_3 0x00000003
126 #define MSI_MSG_STATE_CHANGE 0x00000004
127 #define MSI_MSG_COMPLETION_POSTED 0x00000005
128 #define MSI_MSG_MSG_FROM_DEV 0x00000006
129 #define MSI_MSG_RESERVED_0 0x00000007
130 #define MSI_MSG_RESERVED_1 0x00000008
131 #define MSI_MSG_QUEUE_0_FULL 0x00000009
132 #define MSI_MSG_QUEUE_1_FULL 0x0000000A
133 #define MSI_MSG_QUEUE_2_FULL 0x0000000B
134 #define MSI_MSG_QUEUE_3_FULL 0x0000000C
138 #define FIT_INT_RESERVED_MASK \
139 (FIT_ISH_UNDEFINED_3 | \
142 * Interrupt mask, 32-bit r/w
143 * Bit definitions are the same as FIT_INT_STATUS_HOST
145 #define FIT_INT_MASK_HOST 0x528u
149 * Message to device, 32-bit r/w
151 #define FIT_MSG_TO_DEVICE 0x540u
154 * Message from device, 32-bit, r/o
156 #define FIT_MSG_FROM_DEVICE 0x548u
160 * 32-bit messages to/from device, composition/extraction macros
162 #define FIT_MXD_CONS(TYPE, PARAM, DATA) \
163 ((((TYPE) & 0xFFu) << 24u) | \
164 (((PARAM) & 0xFFu) << 16u) | \
165 (((DATA) & 0xFFFFu) << 0u))
166 #define FIT_MXD_TYPE(MXD) (((MXD) >> 24u) & 0xFFu)
167 #define FIT_MXD_PARAM(MXD) (((MXD) >> 16u) & 0xFFu)
168 #define FIT_MXD_DATA(MXD) (((MXD) >> 0u) & 0xFFFFu)
172 * Types of messages to/from device
174 #define FIT_MTD_FITFW_INIT 0x01u
175 #define FIT_MTD_GET_CMDQ_DEPTH 0x02u
176 #define FIT_MTD_SET_COMPQ_DEPTH 0x03u
177 #define FIT_MTD_SET_COMPQ_ADDR 0x04u
178 #define FIT_MTD_ARM_QUEUE 0x05u
179 #define FIT_MTD_CMD_LOG_HOST_ID 0x07u
180 #define FIT_MTD_CMD_LOG_TIME_STAMP_LO 0x08u
181 #define FIT_MTD_CMD_LOG_TIME_STAMP_HI 0x09u
182 #define FIT_MFD_SMART_EXCEEDED 0x10u
183 #define FIT_MFD_POWER_DOWN 0x11u
184 #define FIT_MFD_OFFLINE 0x12u
185 #define FIT_MFD_ONLINE 0x13u
186 #define FIT_MFD_FW_RESTARTING 0x14u
187 #define FIT_MFD_PM_ACTIVE 0x15u
188 #define FIT_MFD_PM_STANDBY 0x16u
189 #define FIT_MFD_PM_SLEEP 0x17u
190 #define FIT_MFD_CMD_PROGRESS 0x18u
192 #ifndef SKD_OMIT_FROM_SRC_DIST
193 #define FIT_MTD_DEBUG 0xFEu
194 #define FIT_MFD_DEBUG 0xFFu
195 #endif /* SKD_OMIT_FROM_SRC_DIST */
197 #define FIT_MFD_MASK (0xFFu)
198 #define FIT_MFD_DATA_MASK (0xFFu)
199 #define FIT_MFD_MSG(x) (((x) >> 24) & FIT_MFD_MASK)
200 #define FIT_MFD_DATA(x) ((x) & FIT_MFD_MASK)
204 * Extra arg to FIT_MSG_TO_DEVICE, 64-bit r/w
205 * Used to set completion queue address (FIT_MTD_SET_COMPQ_ADDR)
206 * (was Response buffer in docs)
208 #define FIT_MSG_TO_DEVICE_ARG 0x580u
211 * Hardware (ASIC) version, 32-bit r/o
213 #define FIT_HW_VERSION 0x588u
216 * Scatter/gather list descriptor.
217 * 32-bytes and must be aligned on a 32-byte boundary.
218 * All fields are in little endian order.
220 struct fit_sg_descriptor {
223 uint64_t host_side_addr;
224 uint64_t dev_side_addr;
225 uint64_t next_desc_ptr;
228 #define FIT_SGD_CONTROL_NOT_LAST 0x000u
229 #define FIT_SGD_CONTROL_LAST 0x40Eu
232 * Header at the beginning of a FIT message. The header
233 * is followed by SSDI requests each 64 bytes.
234 * A FIT message can be up to 512 bytes long and must start
235 * on a 64-byte boundary.
239 uint8_t num_protocol_cmds_coalesced;
240 uint8_t _reserved[62];
243 #define FIT_PROTOCOL_ID_FIT 1
244 #define FIT_PROTOCOL_ID_SSDI 2
245 #define FIT_PROTOCOL_ID_SOFIT 3
248 #define FIT_PROTOCOL_MINOR_VER(mtd_val) ((mtd_val >> 16) & 0xF)
249 #define FIT_PROTOCOL_MAJOR_VER(mtd_val) ((mtd_val >> 20) & 0xF)
251 #ifndef SKD_OMIT_FROM_SRC_DIST
253 * Format of a completion entry. The completion queue is circular
254 * and must have at least as many entries as the maximum number
255 * of commands that may be issued to the device.
257 * There are no head/tail pointers. The cycle value is used to
258 * infer the presence of new completion records.
259 * Initially the cycle in all entries is 0, the index is 0, and
260 * the cycle value to expect is 1. When completions are added
261 * their cycle values are set to 1. When the index wraps the
262 * cycle value to expect is incremented.
264 * Command_context is opaque and taken verbatim from the SSDI command.
265 * All other fields are big endian.
267 #endif /* SKD_OMIT_FROM_SRC_DIST */
268 #define FIT_PROTOCOL_VERSION_0 0
271 * Protocol major version 1 completion entry.
272 * The major protocol version is found in bits
273 * 20-23 of the FIT_MTD_FITFW_INIT response.
275 struct fit_completion_entry_v1 {
276 uint32_t num_returned_bytes;
278 uint8_t status; /* SCSI status */
281 #define FIT_PROTOCOL_VERSION_1 1
282 #define FIT_PROTOCOL_VERSION_CURRENT FIT_PROTOCOL_VERSION_1
284 struct fit_comp_error_info {
285 uint8_t type:7; /* 00: Bits0-6 indicates the type of sense data. */
286 uint8_t valid:1; /* 00: Bit 7 := 1 ==> info field is valid. */
287 uint8_t reserved0; /* 01: Obsolete field */
288 uint8_t key:4; /* 02: Bits0-3 indicate the sense key. */
289 uint8_t reserved2:1; /* 02: Reserved bit. */
290 uint8_t bad_length:1; /* 02: Incorrect Length Indicator */
291 uint8_t end_medium:1; /* 02: End of Medium */
292 uint8_t file_mark:1; /* 02: Filemark */
293 uint8_t info[4]; /* 03: */
294 uint8_t reserved1; /* 07: Additional Sense Length */
295 uint8_t cmd_spec[4]; /* 08: Command Specific Information */
296 uint8_t code; /* 0C: Additional Sense Code */
297 uint8_t qual; /* 0D: Additional Sense Code Qualifier */
298 uint8_t fruc; /* 0E: Field Replaceable Unit Code */
299 uint8_t sks_high:7; /* 0F: Sense Key Specific (MSB) */
300 uint8_t sks_valid:1; /* 0F: Sense Key Specific Valid */
301 uint16_t sks_low; /* 10: Sense Key Specific (LSW) */
302 uint16_t reserved3; /* 12: Part of additional sense bytes (unused) */
303 uint16_t uec; /* 14: Additional Sense Bytes */
304 uint64_t per; /* 16: Additional Sense Bytes */
305 uint8_t reserved4[2]; /* 1E: Additional Sense Bytes (unused) */
309 /* Task management constants */
310 #define SOFT_TASK_SIMPLE 0x00
311 #define SOFT_TASK_HEAD_OF_QUEUE 0x01
312 #define SOFT_TASK_ORDERED 0x02
315 /* Version zero has the last 32 bits reserved,
316 * Version one has the last 32 bits sg_list_len_bytes;
318 struct skd_command_header {
319 uint64_t sg_list_dma_address;
322 uint8_t add_cdb_len; /* In 32 bit words */
323 uint32_t sg_list_len_bytes;
326 struct skd_scsi_request {
327 struct skd_command_header hdr;
328 unsigned char cdb[16];
329 /* unsigned char _reserved[16]; */
332 struct driver_inquiry_data {
333 uint8_t peripheral_device_type:5;
336 uint16_t page_length;
337 uint16_t pcie_bus_number;
338 uint8_t pcie_device_number;
339 uint8_t pcie_function_number;
340 uint8_t pcie_link_speed;
341 uint8_t pcie_link_lanes;
342 uint16_t pcie_vendor_id;
343 uint16_t pcie_device_id;
344 uint16_t pcie_subsystem_vendor_id;
345 uint16_t pcie_subsystem_device_id;
346 uint8_t reserved1[2];
347 uint8_t reserved2[3];
348 uint8_t driver_version_length;
349 uint8_t driver_version[0x14];
352 #pragma pack(pop, s1120_h)
354 #endif /* SKD_S1120_H */