xref: /freebsd/sys/dev/isci/scil/scif_sas_smp_io_request.h (revision b3e7694832e81d7a904a10f525f8797b753bf0d3)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause OR GPL-2.0
3  *
4  * This file is provided under a dual BSD/GPLv2 license.  When using or
5  * redistributing this file, you may do so under either license.
6  *
7  * GPL LICENSE SUMMARY
8  *
9  * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
10  *
11  * This program is free software; you can redistribute it and/or modify
12  * it under the terms of version 2 of the GNU General Public License as
13  * published by the Free Software Foundation.
14  *
15  * This program is distributed in the hope that it will be useful, but
16  * WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
18  * General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
23  * The full GNU General Public License is included in this distribution
24  * in the file called LICENSE.GPL.
25  *
26  * BSD LICENSE
27  *
28  * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
29  * All rights reserved.
30  *
31  * Redistribution and use in source and binary forms, with or without
32  * modification, are permitted provided that the following conditions
33  * are met:
34  *
35  *   * Redistributions of source code must retain the above copyright
36  *     notice, this list of conditions and the following disclaimer.
37  *   * Redistributions in binary form must reproduce the above copyright
38  *     notice, this list of conditions and the following disclaimer in
39  *     the documentation and/or other materials provided with the
40  *     distribution.
41  *
42  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
43  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
44  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
45  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
46  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
47  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
48  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
49  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
50  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
51  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
52  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
53  */
54 #ifndef _SCIF_SAS_SMP_REQUEST_H_
55 #define _SCIF_SAS_SMP_REQUEST_H_
56 
57 /**
58  * @file
59  *
60  * @brief This file contains the protected interface structures, constants,
61  *        and methods for the SCIF_SAS_SMP_REQUEST object.
62  */
63 
64 #ifdef __cplusplus
65 extern "C" {
66 #endif // __cplusplus
67 
68 #include <dev/isci/scil/intel_sas.h>
69 #include <dev/isci/scil/sci_types.h>
70 #include <dev/isci/scil/sci_status.h>
71 #include <dev/isci/scil/sci_base_request.h>
72 
73 struct SCIF_SAS_REQUEST;
74 struct SCIF_SAS_IO_REQUEST;
75 struct SCIF_SAS_CONTROLLER;
76 struct SCIF_SAS_REMOTE_DEVICE;
77 struct SCIF_SAS_INTERNAL_IO_REQUEST;
78 
79 void scif_sas_smp_request_construct(
80    struct SCIF_SAS_REQUEST * fw_io,
81    SMP_REQUEST_T * smp_command
82 );
83 
84 void * scif_sas_smp_request_construct_report_general(
85    struct SCIF_SAS_CONTROLLER    * fw_controller,
86    struct SCIF_SAS_REMOTE_DEVICE * fw_device
87 );
88 
89 void * scif_sas_smp_request_construct_report_manufacturer_info(
90    struct SCIF_SAS_CONTROLLER    * fw_controller,
91    struct SCIF_SAS_REMOTE_DEVICE * fw_device
92 );
93 
94 void * scif_sas_smp_request_construct_discover(
95    struct SCIF_SAS_CONTROLLER    * fw_controller,
96    struct SCIF_SAS_REMOTE_DEVICE * fw_device,
97    U8                              phy_identifier,
98    void                          * external_request_object,
99    void                          * external_memory
100 );
101 
102 void * scif_sas_smp_request_construct_report_phy_sata(
103    struct SCIF_SAS_CONTROLLER    * fw_controller,
104    struct SCIF_SAS_REMOTE_DEVICE * fw_device,
105    U8                              phy_identifier
106 );
107 
108 void * scif_sas_smp_request_construct_phy_control(
109    struct SCIF_SAS_CONTROLLER    * fw_controller,
110    struct SCIF_SAS_REMOTE_DEVICE * fw_device,
111    U8                         phy_operation,
112    U8                         phy_identifier,
113    void                     * external_request_object,
114    void                     * external_memory
115 );
116 
117 void * scif_sas_smp_request_construct_config_route_info(
118    struct SCIF_SAS_CONTROLLER    * fw_controller,
119    struct SCIF_SAS_REMOTE_DEVICE * fw_device,
120    U8                              phy_id,
121    U16                             route_index,
122    SCI_SAS_ADDRESS_T               destination_sas_Address,
123    BOOL                            disable_expander_route_entry
124 );
125 
126 SCI_STATUS scif_sas_smp_internal_request_retry(
127    struct SCIF_SAS_REMOTE_DEVICE * fw_device
128 );
129 
130 SCI_STATUS scif_sas_smp_external_request_retry(
131    struct SCIF_SAS_IO_REQUEST    * old_io
132 );
133 
134 #ifdef __cplusplus
135 }
136 #endif // __cplusplus
137 
138 #endif
139