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