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 _SCIC_SDS_PORT_CONFIGURATION_AGENT_H_
57 #define _SCIC_SDS_PORT_CONFIGURATION_AGENT_H_
58
59 /**
60 * @file
61 *
62 * @brief This file contains the structures, constants and prototypes used for
63 * the core controller automatic port configuration engine.
64 */
65
66 #ifdef __cplusplus
67 extern "C" {
68 #endif // __cplusplus
69
70 #include <dev/isci/scil/scic_sds_port.h>
71 #include <dev/isci/scil/scic_sds_phy.h>
72
73 struct SCIC_SDS_CONTROLLER;
74 struct SCIC_SDS_PORT_CONFIGURATION_AGENT;
75 struct SCIC_SDS_PORT;
76 struct SCIC_SDS_PHY;
77
78 typedef void (*SCIC_SDS_PORT_CONFIGURATION_AGENT_PHY_HANDLER_T)(
79 struct SCIC_SDS_CONTROLLER *,
80 struct SCIC_SDS_PORT_CONFIGURATION_AGENT *,
81 struct SCIC_SDS_PORT *,
82 struct SCIC_SDS_PHY *
83 );
84
85 struct SCIC_SDS_PORT_RANGE
86 {
87 U8 min_index;
88 U8 max_index;
89 };
90
91 typedef struct SCIC_SDS_PORT_CONFIGURATION_AGENT
92 {
93 U16 phy_configured_mask;
94 U16 phy_ready_mask;
95
96 struct SCIC_SDS_PORT_RANGE phy_valid_port_range[SCI_MAX_PHYS];
97
98 BOOL timer_pending;
99
100 SCIC_SDS_PORT_CONFIGURATION_AGENT_PHY_HANDLER_T link_up_handler;
101 SCIC_SDS_PORT_CONFIGURATION_AGENT_PHY_HANDLER_T link_down_handler;
102
103 void *timer;
104
105 } SCIC_SDS_PORT_CONFIGURATION_AGENT_T;
106
107 void scic_sds_port_configuration_agent_construct(
108 SCIC_SDS_PORT_CONFIGURATION_AGENT_T * port_agent
109 );
110
111 SCI_STATUS scic_sds_port_configuration_agent_initialize(
112 struct SCIC_SDS_CONTROLLER * controller,
113 SCIC_SDS_PORT_CONFIGURATION_AGENT_T * port_agent
114 );
115
116 void scic_sds_port_configuration_agent_destroy(
117 struct SCIC_SDS_CONTROLLER * controller,
118 SCIC_SDS_PORT_CONFIGURATION_AGENT_T * port_agent
119 );
120
121 void scic_sds_port_configuration_agent_release_resource(
122 struct SCIC_SDS_CONTROLLER * controller,
123 SCIC_SDS_PORT_CONFIGURATION_AGENT_T * port_agent
124 );
125
126 #ifdef __cplusplus
127 }
128 #endif // __cplusplus
129
130 #endif // _SCIC_SDS_PORT_CONFIGURATION_AGENT_H_
Cache object: 943c40d86b26338871d2e9c58ded32b3
|