intel_sas.h 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737
  1. /*
  2. * This file is provided under a dual BSD/GPLv2 license. When using or
  3. * redistributing this file, you may do so under either license.
  4. *
  5. * GPL LICENSE SUMMARY
  6. *
  7. * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
  8. *
  9. * This program is free software; you can redistribute it and/or modify
  10. * it under the terms of version 2 of the GNU General Public License as
  11. * published by the Free Software Foundation.
  12. *
  13. * This program is distributed in the hope that it will be useful, but
  14. * WITHOUT ANY WARRANTY; without even the implied warranty of
  15. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  16. * General Public License for more details.
  17. *
  18. * You should have received a copy of the GNU General Public License
  19. * along with this program; if not, write to the Free Software
  20. * Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
  21. * The full GNU General Public License is included in this distribution
  22. * in the file called LICENSE.GPL.
  23. *
  24. * BSD LICENSE
  25. *
  26. * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
  27. * All rights reserved.
  28. *
  29. * Redistribution and use in source and binary forms, with or without
  30. * modification, are permitted provided that the following conditions
  31. * are met:
  32. *
  33. * * Redistributions of source code must retain the above copyright
  34. * notice, this list of conditions and the following disclaimer.
  35. * * Redistributions in binary form must reproduce the above copyright
  36. * notice, this list of conditions and the following disclaimer in
  37. * the documentation and/or other materials provided with the
  38. * distribution.
  39. * * Neither the name of Intel Corporation nor the names of its
  40. * contributors may be used to endorse or promote products derived
  41. * from this software without specific prior written permission.
  42. *
  43. * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  44. * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  45. * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  46. * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  47. * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  48. * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  49. * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  50. * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  51. * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  52. * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  53. * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  54. */
  55. #ifndef _INTEL_SAS_H_
  56. #define _INTEL_SAS_H_
  57. /**
  58. * This file contains all of the definitions relating to structures, constants,
  59. * etc. defined by the SAS specification.
  60. *
  61. *
  62. */
  63. #include "intel_sata.h"
  64. #include "intel_scsi.h"
  65. /**
  66. * struct sci_sas_address - This structure depicts how a SAS address is
  67. * represented by SCI.
  68. *
  69. *
  70. */
  71. struct sci_sas_address {
  72. /**
  73. * This member contains the higher 32-bits of the SAS address.
  74. */
  75. u32 high;
  76. /**
  77. * This member contains the lower 32-bits of the SAS address.
  78. */
  79. u32 low;
  80. };
  81. /**
  82. * struct sci_sas_identify_address_frame_protocols - This structure depicts the
  83. * contents of bytes 2 and 3 in the SAS IDENTIFY ADDRESS FRAME (IAF).
  84. *
  85. * For specific information on each of these individual fields please reference
  86. * the SAS specification Link layer section on address frames.
  87. */
  88. struct sci_sas_identify_address_frame_protocols {
  89. union {
  90. struct {
  91. u16 restricted1:1;
  92. u16 smp_initiator:1;
  93. u16 stp_initiator:1;
  94. u16 ssp_initiator:1;
  95. u16 reserved3:4;
  96. u16 restricted2:1;
  97. u16 smp_target:1;
  98. u16 stp_target:1;
  99. u16 ssp_target:1;
  100. u16 reserved4:4;
  101. } bits;
  102. u16 all;
  103. } u;
  104. };
  105. /**
  106. * struct sci_sas_identify_address_frame - This structure depicts the contents
  107. * of the SAS IDENTIFY ADDRESS FRAME (IAF).
  108. *
  109. * For specific information on each of these individual fields please reference
  110. * the SAS specification Link layer section on address frames.
  111. */
  112. struct sci_sas_identify_address_frame {
  113. u16 address_frame_type:4;
  114. u16 device_type:3;
  115. u16 reserved1:1;
  116. u16 reason:4;
  117. u16 reserved2:4;
  118. struct sci_sas_identify_address_frame_protocols protocols;
  119. struct sci_sas_address device_name;
  120. struct sci_sas_address sas_address;
  121. u32 phy_identifier:8;
  122. u32 break_reply_capable:1;
  123. u32 requested_in_zpsds:1;
  124. u32 in_zpsds_persistent:1;
  125. u32 reserved5:21;
  126. u32 reserved6[4];
  127. };
  128. /**
  129. * struct sas_capabilities - This structure depicts the various SAS
  130. * capabilities supported by the directly attached target device. For
  131. * specific information on each of these individual fields please reference
  132. * the SAS specification Phy layer section on speed negotiation windows.
  133. *
  134. *
  135. */
  136. struct sas_capabilities {
  137. union {
  138. #if defined (SCIC_SDS_4_ENABLED)
  139. struct {
  140. /**
  141. * The SAS specification indicates the start bit shall always be set to
  142. * 1. This implementation will have the start bit set to 0 if the
  143. * PHY CAPABILITIES were either not received or speed negotiation failed.
  144. */
  145. u32 start:1;
  146. u32 tx_ssc_type:1;
  147. u32 reserved1:2;
  148. u32 requested_logical_link_rate:4;
  149. u32 gen1_without_ssc_supported:1;
  150. u32 gen1_with_ssc_supported:1;
  151. u32 gen2_without_ssc_supported:1;
  152. u32 gen2_with_ssc_supported:1;
  153. u32 gen3_without_ssc_supported:1;
  154. u32 gen3_with_ssc_supported:1;
  155. u32 reserved2:17;
  156. u32 parity:1;
  157. } bits;
  158. #endif /* (SCIC_SDS_4_ENABLED) */
  159. u32 all;
  160. } u;
  161. };
  162. /**
  163. * enum _SCI_SAS_TASK_ATTRIBUTE - This enumeration depicts the SAM/SAS
  164. * specification defined task attribute values for a command information
  165. * unit.
  166. *
  167. *
  168. */
  169. enum sci_sas_task_attribute {
  170. SCI_SAS_SIMPLE_ATTRIBUTE = 0,
  171. SCI_SAS_HEAD_OF_QUEUE_ATTRIBUTE = 1,
  172. SCI_SAS_ORDERED_ATTRIBUTE = 2,
  173. SCI_SAS_ACA_ATTRIBUTE = 4,
  174. };
  175. /**
  176. * enum _SCI_SAS_TASK_MGMT_FUNCTION - This enumeration depicts the SAM/SAS
  177. * specification defined task management functions.
  178. *
  179. * This HARD_RESET function listed here is not actually defined as a task
  180. * management function in the industry standard.
  181. */
  182. enum sci_sas_task_mgmt_function {
  183. SCI_SAS_ABORT_TASK = SCSI_TASK_REQUEST_ABORT_TASK,
  184. SCI_SAS_ABORT_TASK_SET = SCSI_TASK_REQUEST_ABORT_TASK_SET,
  185. SCI_SAS_CLEAR_TASK_SET = SCSI_TASK_REQUEST_CLEAR_TASK_SET,
  186. SCI_SAS_LOGICAL_UNIT_RESET = SCSI_TASK_REQUEST_LOGICAL_UNIT_RESET,
  187. SCI_SAS_I_T_NEXUS_RESET = SCSI_TASK_REQUEST_I_T_NEXUS_RESET,
  188. SCI_SAS_CLEAR_ACA = SCSI_TASK_REQUEST_CLEAR_ACA,
  189. SCI_SAS_QUERY_TASK = SCSI_TASK_REQUEST_QUERY_TASK,
  190. SCI_SAS_QUERY_TASK_SET = SCSI_TASK_REQUEST_QUERY_TASK_SET,
  191. SCI_SAS_QUERY_ASYNCHRONOUS_EVENT = SCSI_TASK_REQUEST_QUERY_UNIT_ATTENTION,
  192. SCI_SAS_HARD_RESET = 0xFF
  193. };
  194. /**
  195. * enum _SCI_SAS_FRAME_TYPE - This enumeration depicts the SAS specification
  196. * defined SSP frame types.
  197. *
  198. *
  199. */
  200. enum sci_sas_frame_type {
  201. SCI_SAS_DATA_FRAME = 0x01,
  202. SCI_SAS_XFER_RDY_FRAME = 0x05,
  203. SCI_SAS_COMMAND_FRAME = 0x06,
  204. SCI_SAS_RESPONSE_FRAME = 0x07,
  205. SCI_SAS_TASK_FRAME = 0x16
  206. };
  207. /**
  208. * struct sci_ssp_command_iu - This structure depicts the contents of the SSP
  209. * COMMAND INFORMATION UNIT. For specific information on each of these
  210. * individual fields please reference the SAS specification SSP transport
  211. * layer section.
  212. *
  213. *
  214. */
  215. struct sci_ssp_command_iu {
  216. u32 lun_upper;
  217. u32 lun_lower;
  218. u32 additional_cdb_length:6;
  219. u32 reserved0:2;
  220. u32 reserved1:8;
  221. u32 enable_first_burst:1;
  222. u32 task_priority:4;
  223. u32 task_attribute:3;
  224. u32 reserved2:8;
  225. u32 cdb[4];
  226. };
  227. /**
  228. * struct sci_ssp_task_iu - This structure depicts the contents of the SSP TASK
  229. * INFORMATION UNIT. For specific information on each of these individual
  230. * fields please reference the SAS specification SSP transport layer section.
  231. *
  232. *
  233. */
  234. struct sci_ssp_task_iu {
  235. u32 lun_upper;
  236. u32 lun_lower;
  237. u32 reserved0:8;
  238. u32 task_function:8;
  239. u32 reserved1:8;
  240. u32 reserved2:8;
  241. u32 reserved3:16;
  242. u32 task_tag:16;
  243. u32 reserved4[3];
  244. };
  245. #define SSP_RESPONSE_IU_MAX_DATA 64
  246. #define SCI_SSP_RESPONSE_IU_DATA_PRESENT_MASK (0x03)
  247. #define sci_ssp_get_sense_data_length(sense_data_length_buffer) \
  248. SCIC_BUILD_DWORD(sense_data_length_buffer)
  249. #define sci_ssp_get_response_data_length(response_data_length_buffer) \
  250. SCIC_BUILD_DWORD(response_data_length_buffer)
  251. /**
  252. * struct sci_ssp_response_iu - This structure depicts the contents of the SSP
  253. * RESPONSE INFORMATION UNIT. For specific information on each of these
  254. * individual fields please reference the SAS specification SSP transport
  255. * layer section.
  256. *
  257. *
  258. */
  259. struct sci_ssp_response_iu {
  260. u8 reserved0[8];
  261. u8 retry_delay_timer[2];
  262. u8 data_present;
  263. u8 status;
  264. u8 reserved1[4];
  265. u8 sense_data_length[4];
  266. u8 response_data_length[4];
  267. u32 data[SSP_RESPONSE_IU_MAX_DATA];
  268. };
  269. /**
  270. * enum _SCI_SAS_DATA_PRESENT_TYPE - This enumeration depicts the SAS
  271. * specification defined SSP data present types in struct sci_ssp_response_iu.
  272. *
  273. *
  274. */
  275. enum sci_ssp_response_iu_data_present_type {
  276. SCI_SSP_RESPONSE_IU_NO_DATA = 0x00,
  277. SCI_SSP_RESPONSE_IU_RESPONSE_DATA = 0x01,
  278. SCI_SSP_RESPONSE_IU_SENSE_DATA = 0x02
  279. };
  280. /**
  281. * struct sci_ssp_frame_header - This structure depicts the contents of an SSP
  282. * frame header. For specific information on the individual fields please
  283. * reference the SAS specification transport layer SSP frame format.
  284. *
  285. *
  286. */
  287. struct sci_ssp_frame_header {
  288. /* Word 0 */
  289. u32 hashed_destination_address:24;
  290. u32 frame_type:8;
  291. /* Word 1 */
  292. u32 hashed_source_address:24;
  293. u32 reserved1_0:8;
  294. /* Word 2 */
  295. u32 reserved2_2:6;
  296. u32 fill_bytes:2;
  297. u32 reserved2_1:3;
  298. u32 tlr_control:2;
  299. u32 retry_data_frames:1;
  300. u32 retransmit:1;
  301. u32 changing_data_pointer:1;
  302. u32 reserved2_0:16;
  303. /* Word 3 */
  304. u32 uiResv4;
  305. /* Word 4 */
  306. u16 target_port_transfer_tag;
  307. u16 tag;
  308. /* Word 5 */
  309. u32 data_offset;
  310. };
  311. /**
  312. * struct smp_request_header - This structure defines the contents of an SMP
  313. * Request header.
  314. *
  315. * For specific information on each of these individual fields please reference
  316. * the SAS specification.
  317. */
  318. struct smp_request_header {
  319. u8 smp_frame_type; /* byte 0 */
  320. u8 function; /* byte 1 */
  321. u8 allocated_response_length; /* byte 2 */
  322. u8 request_length; /* byte 3 */
  323. };
  324. /**
  325. * struct smp_response_header - This structure depicts the contents of the SAS
  326. * SMP DISCOVER RESPONSE frame. For specific information on each of these
  327. * individual fields please reference the SAS specification Link layer
  328. * section on address frames.
  329. *
  330. *
  331. */
  332. struct smp_response_header {
  333. u8 smp_frame_type; /* byte 0 */
  334. u8 function; /* byte 1 */
  335. u8 function_result; /* byte 2 */
  336. u8 response_length; /* byte 3 */
  337. };
  338. /**
  339. * struct smp_request_general - This structure defines the contents of an SMP
  340. * Request that is comprised of the struct smp_request_header and a CRC.
  341. *
  342. * For specific information on each of these individual fields please reference
  343. * the SAS specification.
  344. */
  345. struct smp_request_general {
  346. u32 crc; /* bytes 4-7 */
  347. };
  348. /**
  349. * struct smp_request_phy_identifier - This structure defines the contents of
  350. * an SMP Request that is comprised of the struct smp_request_header and a phy
  351. * identifier. Examples: SMP_REQUEST_DISCOVER, SMP_REQUEST_REPORT_PHY_SATA.
  352. *
  353. * For specific information on each of these individual fields please reference
  354. * the SAS specification.
  355. */
  356. struct smp_request_phy_identifier {
  357. u32 reserved_byte4_7; /* bytes 4-7 */
  358. u32 ignore_zone_group:1; /* byte 8 */
  359. u32 reserved_byte8:7;
  360. u32 phy_identifier:8; /* byte 9 */
  361. u32 reserved_byte10:8; /* byte 10 */
  362. u32 reserved_byte11:8; /* byte 11 */
  363. };
  364. /**
  365. * struct smp_request_configure_route_information - This structure defines the
  366. * contents of an SMP Configure Route Information request.
  367. *
  368. * For specific information on each of these individual fields please reference
  369. * the SAS specification.
  370. */
  371. struct smp_request_configure_route_information {
  372. u32 expected_expander_change_count:16; /* bytes 4-5 */
  373. u32 expander_route_index_high:8;
  374. u32 expander_route_index:8; /* bytes 6-7 */
  375. u32 reserved_byte8:8; /* bytes 8 */
  376. u32 phy_identifier:8; /* bytes 9 */
  377. u32 reserved_byte_10_11:16; /* bytes 10-11 */
  378. u32 reserved_byte_12_bit_0_6:7;
  379. u32 disable_route_entry:1; /* byte 12 */
  380. u32 reserved_byte_13_15:24; /* bytes 13-15 */
  381. u32 routed_sas_address[2]; /* bytes 16-23 */
  382. u8 reserved_byte_24_39[16]; /* bytes 24-39 */
  383. };
  384. /**
  385. * struct smp_request_phy_control - This structure defines the contents of an
  386. * SMP Phy Controler request.
  387. *
  388. * For specific information on each of these individual fields please reference
  389. * the SAS specification.
  390. */
  391. struct smp_request_phy_control {
  392. u16 expected_expander_change_count; /* byte 4-5 */
  393. u16 reserved_byte_6_7; /* byte 6-7 */
  394. u8 reserved_byte_8; /* byte 8 */
  395. u8 phy_identifier; /* byte 9 */
  396. u8 phy_operation; /* byte 10 */
  397. u8 update_partial_pathway_timeout_value:1;
  398. u8 reserved_byte_11_bit_1_7:7; /* byte 11 */
  399. u8 reserved_byte_12_23[12]; /* byte 12-23 */
  400. u8 attached_device_name[8]; /* byte 24-31 */
  401. u8 reserved_byte_32_bit_3_0:4; /* byte 32 */
  402. u8 programmed_minimum_physical_link_rate:4;
  403. u8 reserved_byte_33_bit_3_0:4; /* byte 33 */
  404. u8 programmed_maximum_physical_link_rate:4;
  405. u16 reserved_byte_34_35; /* byte 34-35 */
  406. u8 partial_pathway_timeout_value:4;
  407. u8 reserved_byte_36_bit_4_7:4; /* byte 36 */
  408. u16 reserved_byte_37_38; /* byte 37-38 */
  409. u8 reserved_byte_39; /* byte 39 */
  410. };
  411. /**
  412. * struct smp_request_vendor_specific - This structure depicts the vendor
  413. * specific space for SMP request.
  414. *
  415. *
  416. */
  417. #define SMP_REQUEST_VENDOR_SPECIFIC_MAX_LENGTH 1016
  418. struct smp_request_vendor_specific {
  419. u8 request_bytes[SMP_REQUEST_VENDOR_SPECIFIC_MAX_LENGTH];
  420. };
  421. /**
  422. * struct smp_request - This structure simply unionizes the existing request
  423. * structures into a common request type.
  424. *
  425. *
  426. */
  427. struct smp_request {
  428. struct smp_request_header header;
  429. union { /* bytes 4-N */
  430. struct smp_request_general report_general;
  431. struct smp_request_phy_identifier discover;
  432. struct smp_request_general report_manufacturer_information;
  433. struct smp_request_phy_identifier report_phy_sata;
  434. struct smp_request_phy_control phy_control;
  435. struct smp_request_phy_identifier report_phy_error_log;
  436. struct smp_request_phy_identifier report_route_information;
  437. struct smp_request_configure_route_information configure_route_information;
  438. struct smp_request_vendor_specific vendor_specific_request;
  439. } request;
  440. };
  441. /**
  442. * struct smp_response_report_general - This structure depicts the SMP Report
  443. * General for expander devices. It adheres to the SAS-2.1 specification.
  444. *
  445. * For specific information on each of these individual fields please reference
  446. * the SAS specification Application layer section on SMP.
  447. */
  448. struct smp_response_report_general {
  449. u16 expander_change_count; /* byte 4-5 */
  450. u16 expander_route_indexes; /* byte 6-7 */
  451. u32 reserved_byte8:7; /* byte 8 bit 0-6 */
  452. u32 long_response:1; /* byte 8 bit 7 */
  453. u32 number_of_phys:8; /* byte 9 */
  454. u32 configurable_route_table:1; /* byte 10 */
  455. u32 configuring:1;
  456. u32 configures_others:1;
  457. u32 open_reject_retry_supported:1;
  458. u32 stp_continue_awt:1;
  459. u32 self_configuring:1;
  460. u32 zone_configuring:1;
  461. u32 table_to_table_supported:1;
  462. u32 reserved_byte11:8; /* byte 11 */
  463. u32 enclosure_logical_identifier_high; /* byte 12-15 */
  464. u32 enclosure_logical_identifier_low; /* byte 16-19 */
  465. u32 reserved_byte20_23;
  466. u32 reserved_byte24_27;
  467. };
  468. struct smp_response_report_general_long {
  469. struct smp_response_report_general sas1_1;
  470. struct {
  471. u16 reserved1;
  472. u16 stp_bus_inactivity_time_limit;
  473. u16 stp_max_connect_time_limit;
  474. u16 stp_smp_i_t_nexus_loss_time;
  475. u32 zoning_enabled:1;
  476. u32 zoning_supported:1;
  477. u32 physicaL_presence_asserted:1;
  478. u32 zone_locked:1;
  479. u32 reserved2:1;
  480. u32 num_zone_groups:3;
  481. u32 saving_zoning_enabled_supported:3;
  482. u32 saving_zone_perms_table_supported:1;
  483. u32 saving_zone_phy_info_supported:1;
  484. u32 saving_zone_manager_password_supported:1;
  485. u32 saving:1;
  486. u32 reserved3:1;
  487. u32 max_number_routed_sas_addresses:16;
  488. struct sci_sas_address active_zone_manager_sas_address;
  489. u16 zone_lock_inactivity_time_limit;
  490. u16 reserved4;
  491. u8 reserved5;
  492. u8 first_enclosure_connector_element_index;
  493. u8 number_of_enclosure_connector_element_indices;
  494. u8 reserved6;
  495. u32 reserved7:7;
  496. u32 reduced_functionality:1;
  497. u32 time_to_reduce_functionality:8;
  498. u32 initial_time_to_reduce_functionality:8;
  499. u8 max_reduced_functionality_time;
  500. u16 last_self_config_status_descriptor_index;
  501. u16 max_number_of_stored_self_config_status_descriptors;
  502. u16 last_phy_event_list_descriptor_index;
  503. u16 max_number_of_stored_phy_event_list_descriptors;
  504. } sas2;
  505. };
  506. /**
  507. * struct smp_response_report_manufacturer_information - This structure depicts
  508. * the SMP report manufacturer information for expander devices. It adheres
  509. * to the SAS-2.1 specification.
  510. *
  511. * For specific information on each of these individual fields please reference
  512. * the SAS specification Application layer section on SMP.
  513. */
  514. struct smp_response_report_manufacturer_information {
  515. u32 expander_change_count:16; /* bytes 4-5 */
  516. u32 reserved1:16;
  517. u32 sas1_1_format:1;
  518. u32 reserved2:31;
  519. u8 vendor_id[8];
  520. u8 product_id[16];
  521. u8 product_revision_level[4];
  522. u8 component_vendor_id[8];
  523. u8 component_id[2];
  524. u8 component_revision_level;
  525. u8 reserved3;
  526. u8 vendor_specific[8];
  527. };
  528. /**
  529. * struct smp_response_report_phy_sata - This structure depicts the contents of
  530. * the SAS SMP REPORT PHY SATA frame. For specific information on each of
  531. * these individual fields please reference the SAS specification Link layer
  532. * section on address frames.
  533. *
  534. *
  535. */
  536. struct smp_response_report_phy_sata {
  537. u32 ignored_byte_4_7; /* bytes 4-7 */
  538. u32 affiliations_valid:1;
  539. u32 affiliations_supported:1;
  540. u32 reserved_byte11:6; /* byte 11 */
  541. u32 ignored_byte10:8; /* byte 10 */
  542. u32 phy_identifier:8; /* byte 9 */
  543. u32 reserved_byte_8:8; /* byte 8 */
  544. u32 reserved_12_15;
  545. u32 stp_sas_address[2];
  546. u8 device_to_host_fis[20];
  547. u32 reserved_44_47;
  548. u32 affiliated_stp_initiator_sas_address[2];
  549. };
  550. struct smp_response_vendor_specific {
  551. u8 response_bytes[SMP_REQUEST_VENDOR_SPECIFIC_MAX_LENGTH];
  552. };
  553. union smp_response_body {
  554. struct smp_response_report_general report_general;
  555. struct smp_response_report_manufacturer_information report_manufacturer_information;
  556. struct smp_response_report_phy_sata report_phy_sata;
  557. struct smp_response_vendor_specific vendor_specific_response;
  558. };
  559. /**
  560. * struct smp_response - This structure simply unionizes the existing response
  561. * structures into a common response type.
  562. *
  563. *
  564. */
  565. struct smp_response {
  566. struct smp_response_header header;
  567. union smp_response_body response;
  568. };
  569. /* SMP Request Functions */
  570. #define SMP_FUNCTION_REPORT_GENERAL 0x00
  571. #define SMP_FUNCTION_REPORT_MANUFACTURER_INFORMATION 0x01
  572. #define SMP_FUNCTION_DISCOVER 0x10
  573. #define SMP_FUNCTION_REPORT_PHY_ERROR_LOG 0x11
  574. #define SMP_FUNCTION_REPORT_PHY_SATA 0x12
  575. #define SMP_FUNCTION_REPORT_ROUTE_INFORMATION 0X13
  576. #define SMP_FUNCTION_CONFIGURE_ROUTE_INFORMATION 0X90
  577. #define SMP_FUNCTION_PHY_CONTROL 0x91
  578. #define SMP_FUNCTION_PHY_TEST 0x92
  579. #define SMP_FRAME_TYPE_REQUEST 0x40
  580. #define SMP_FRAME_TYPE_RESPONSE 0x41
  581. #define PHY_OPERATION_NOP 0x00
  582. #define PHY_OPERATION_LINK_RESET 0x01
  583. #define PHY_OPERATION_HARD_RESET 0x02
  584. #define PHY_OPERATION_DISABLE 0x03
  585. #define PHY_OPERATION_CLEAR_ERROR_LOG 0x05
  586. #define PHY_OPERATION_CLEAR_AFFILIATION 0x06
  587. #define NPLR_PHY_ENABLED_UNK_LINK_RATE 0x00
  588. #define NPLR_PHY_DISABLED 0x01
  589. #define NPLR_PHY_ENABLED_SPD_NEG_FAILED 0x02
  590. #define NPLR_PHY_ENABLED_SATA_HOLD 0x03
  591. #define NPLR_PHY_ENABLED_1_5G 0x08
  592. #define NPLR_PHY_ENABLED_3_0G 0x09
  593. /* SMP Function Result values. */
  594. #define SMP_RESULT_FUNCTION_ACCEPTED 0x00
  595. #define SMP_RESULT_UNKNOWN_FUNCTION 0x01
  596. #define SMP_RESULT_FUNCTION_FAILED 0x02
  597. #define SMP_RESULT_INVALID_REQUEST_FRAME_LEN 0x03
  598. #define SMP_RESULT_INAVALID_EXPANDER_CHANGE_COUNT 0x04
  599. #define SMP_RESULT_BUSY 0x05
  600. #define SMP_RESULT_INCOMPLETE_DESCRIPTOR_LIST 0x06
  601. #define SMP_RESULT_PHY_DOES_NOT_EXIST 0x10
  602. #define SMP_RESULT_INDEX_DOES_NOT_EXIST 0x11
  603. #define SMP_RESULT_PHY_DOES_NOT_SUPPORT_SATA 0x12
  604. #define SMP_RESULT_UNKNOWN_PHY_OPERATION 0x13
  605. #define SMP_RESULT_UNKNOWN_PHY_TEST_FUNCTION 0x14
  606. #define SMP_RESULT_PHY_TEST_IN_PROGRESS 0x15
  607. #define SMP_RESULT_PHY_VACANT 0x16
  608. /* Attached Device Types */
  609. #define SMP_NO_DEVICE_ATTACHED 0
  610. #define SMP_END_DEVICE_ONLY 1
  611. #define SMP_EDGE_EXPANDER_DEVICE 2
  612. #define SMP_FANOUT_EXPANDER_DEVICE 3
  613. /* Expander phy routine attribute */
  614. #define DIRECT_ROUTING_ATTRIBUTE 0
  615. #define SUBTRACTIVE_ROUTING_ATTRIBUTE 1
  616. #define TABLE_ROUTING_ATTRIBUTE 2
  617. #endif /* _INTEL_SAS_H_ */