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 * $FreeBSD$
55 */
56#ifndef _SCIF_SAS_SMP_REQUEST_H_
57#define _SCIF_SAS_SMP_REQUEST_H_
58
59/**
60 * @file
61 *
62 * @brief This file contains the protected interface structures, constants,
63 *        and methods for the SCIF_SAS_SMP_REQUEST object.
64 */
65
66#ifdef __cplusplus
67extern "C" {
68#endif // __cplusplus
69
70#include <dev/isci/scil/intel_sas.h>
71#include <dev/isci/scil/sci_types.h>
72#include <dev/isci/scil/sci_status.h>
73#include <dev/isci/scil/sci_base_request.h>
74
75struct SCIF_SAS_REQUEST;
76struct SCIF_SAS_IO_REQUEST;
77struct SCIF_SAS_CONTROLLER;
78struct SCIF_SAS_REMOTE_DEVICE;
79struct SCIF_SAS_INTERNAL_IO_REQUEST;
80
81void scif_sas_smp_request_construct(
82   struct SCIF_SAS_REQUEST * fw_io,
83   SMP_REQUEST_T * smp_command
84);
85
86void * scif_sas_smp_request_construct_report_general(
87   struct SCIF_SAS_CONTROLLER    * fw_controller,
88   struct SCIF_SAS_REMOTE_DEVICE * fw_device
89);
90
91void * scif_sas_smp_request_construct_report_manufacturer_info(
92   struct SCIF_SAS_CONTROLLER    * fw_controller,
93   struct SCIF_SAS_REMOTE_DEVICE * fw_device
94);
95
96void * scif_sas_smp_request_construct_discover(
97   struct SCIF_SAS_CONTROLLER    * fw_controller,
98   struct SCIF_SAS_REMOTE_DEVICE * fw_device,
99   U8                              phy_identifier,
100   void                          * external_request_object,
101   void                          * external_memory
102);
103
104void * scif_sas_smp_request_construct_report_phy_sata(
105   struct SCIF_SAS_CONTROLLER    * fw_controller,
106   struct SCIF_SAS_REMOTE_DEVICE * fw_device,
107   U8                              phy_identifier
108);
109
110void * scif_sas_smp_request_construct_phy_control(
111   struct SCIF_SAS_CONTROLLER    * fw_controller,
112   struct SCIF_SAS_REMOTE_DEVICE * fw_device,
113   U8                         phy_operation,
114   U8                         phy_identifier,
115   void                     * external_request_object,
116   void                     * external_memory
117);
118
119void * scif_sas_smp_request_construct_config_route_info(
120   struct SCIF_SAS_CONTROLLER    * fw_controller,
121   struct SCIF_SAS_REMOTE_DEVICE * fw_device,
122   U8                              phy_id,
123   U16                             route_index,
124   SCI_SAS_ADDRESS_T               destination_sas_Address,
125   BOOL                            disable_expander_route_entry
126);
127
128SCI_STATUS scif_sas_smp_internal_request_retry(
129   struct SCIF_SAS_REMOTE_DEVICE * fw_device
130);
131
132SCI_STATUS scif_sas_smp_external_request_retry(
133   struct SCIF_SAS_IO_REQUEST    * old_io
134);
135
136#ifdef __cplusplus
137}
138#endif // __cplusplus
139
140#endif
141