1f11c7f63SJim Harris /*-
2718cf2ccSPedro F. Giffuni * SPDX-License-Identifier: BSD-2-Clause OR GPL-2.0
3718cf2ccSPedro F. Giffuni *
4f11c7f63SJim Harris * This file is provided under a dual BSD/GPLv2 license. When using or
5f11c7f63SJim Harris * redistributing this file, you may do so under either license.
6f11c7f63SJim Harris *
7f11c7f63SJim Harris * GPL LICENSE SUMMARY
8f11c7f63SJim Harris *
9f11c7f63SJim Harris * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
10f11c7f63SJim Harris *
11f11c7f63SJim Harris * This program is free software; you can redistribute it and/or modify
12f11c7f63SJim Harris * it under the terms of version 2 of the GNU General Public License as
13f11c7f63SJim Harris * published by the Free Software Foundation.
14f11c7f63SJim Harris *
15f11c7f63SJim Harris * This program is distributed in the hope that it will be useful, but
16f11c7f63SJim Harris * WITHOUT ANY WARRANTY; without even the implied warranty of
17f11c7f63SJim Harris * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18f11c7f63SJim Harris * General Public License for more details.
19f11c7f63SJim Harris *
20f11c7f63SJim Harris * You should have received a copy of the GNU General Public License
21f11c7f63SJim Harris * along with this program; if not, write to the Free Software
22f11c7f63SJim Harris * Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
23f11c7f63SJim Harris * The full GNU General Public License is included in this distribution
24f11c7f63SJim Harris * in the file called LICENSE.GPL.
25f11c7f63SJim Harris *
26f11c7f63SJim Harris * BSD LICENSE
27f11c7f63SJim Harris *
28f11c7f63SJim Harris * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
29f11c7f63SJim Harris * All rights reserved.
30f11c7f63SJim Harris *
31f11c7f63SJim Harris * Redistribution and use in source and binary forms, with or without
32f11c7f63SJim Harris * modification, are permitted provided that the following conditions
33f11c7f63SJim Harris * are met:
34f11c7f63SJim Harris *
35f11c7f63SJim Harris * * Redistributions of source code must retain the above copyright
36f11c7f63SJim Harris * notice, this list of conditions and the following disclaimer.
37f11c7f63SJim Harris * * Redistributions in binary form must reproduce the above copyright
38f11c7f63SJim Harris * notice, this list of conditions and the following disclaimer in
39f11c7f63SJim Harris * the documentation and/or other materials provided with the
40f11c7f63SJim Harris * distribution.
41f11c7f63SJim Harris *
42f11c7f63SJim Harris * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
43f11c7f63SJim Harris * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
44f11c7f63SJim Harris * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
45f11c7f63SJim Harris * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
46f11c7f63SJim Harris * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
47f11c7f63SJim Harris * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
48f11c7f63SJim Harris * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
49f11c7f63SJim Harris * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
50f11c7f63SJim Harris * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
51f11c7f63SJim Harris * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
52f11c7f63SJim Harris * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
53f11c7f63SJim Harris */
54f11c7f63SJim Harris
55f11c7f63SJim Harris #include <sys/cdefs.h>
56f11c7f63SJim Harris /**
57f11c7f63SJim Harris * @file
58f11c7f63SJim Harris *
59f11c7f63SJim Harris * @brief This file contains all of method implementations specific to
60f11c7f63SJim Harris * the high priority request queue (HPRQ). See the
61f11c7f63SJim Harris * scif_sas_high_priority_request_queue.h file for additional
62f11c7f63SJim Harris * information.
63f11c7f63SJim Harris */
64f11c7f63SJim Harris
65f11c7f63SJim Harris #include <dev/isci/scil/scif_sas_high_priority_request_queue.h>
66f11c7f63SJim Harris
67f11c7f63SJim Harris #include <dev/isci/scil/scif_sas_logger.h>
68f11c7f63SJim Harris #include <dev/isci/scil/scif_sas_io_request.h>
69f11c7f63SJim Harris #include <dev/isci/scil/scif_sas_controller.h>
70f11c7f63SJim Harris
71f11c7f63SJim Harris /**
72f11c7f63SJim Harris * @brief This method initializes the fields of the HPRQ. It should be
73f11c7f63SJim Harris * called during the construction of the object containing or
74f11c7f63SJim Harris * utilizing it (i.e. SCIF_SAS_CONTROLLER).
75f11c7f63SJim Harris *
76f11c7f63SJim Harris * @param[in] fw_hprq This parameter specific the high priority request
77f11c7f63SJim Harris * queue object being constructed.
78f11c7f63SJim Harris *
79f11c7f63SJim Harris * @return none
80f11c7f63SJim Harris */
scif_sas_high_priority_request_queue_construct(SCIF_SAS_HIGH_PRIORITY_REQUEST_QUEUE_T * fw_hprq,SCI_BASE_LOGGER_T * logger)81f11c7f63SJim Harris void scif_sas_high_priority_request_queue_construct(
82f11c7f63SJim Harris SCIF_SAS_HIGH_PRIORITY_REQUEST_QUEUE_T * fw_hprq,
83f11c7f63SJim Harris SCI_BASE_LOGGER_T * logger
84f11c7f63SJim Harris )
85f11c7f63SJim Harris {
86f11c7f63SJim Harris SCIF_LOG_TRACE((
87f11c7f63SJim Harris logger,
88f11c7f63SJim Harris SCIF_LOG_OBJECT_CONTROLLER | SCIF_LOG_OBJECT_DOMAIN_DISCOVERY,
89f11c7f63SJim Harris "scif_sas_high_priority_request_queue_construct(0x%x,0x%x) enter\n",
90f11c7f63SJim Harris fw_hprq, logger
91f11c7f63SJim Harris ));
92f11c7f63SJim Harris
93f11c7f63SJim Harris sci_base_object_construct((SCI_BASE_OBJECT_T*) &fw_hprq->lock, logger);
94f11c7f63SJim Harris fw_hprq->lock.level = SCI_LOCK_LEVEL_NONE;
95f11c7f63SJim Harris
96f11c7f63SJim Harris sci_pool_initialize(fw_hprq->pool);
97f11c7f63SJim Harris }
98f11c7f63SJim Harris
99f11c7f63SJim Harris /**
100f11c7f63SJim Harris * @brief This method will ensure all internal requests destined for
101f11c7f63SJim Harris * devices contained in the supplied domain are properly removed
102f11c7f63SJim Harris * from the high priority request queue.
103f11c7f63SJim Harris *
104f11c7f63SJim Harris * @param[in] fw_hprq This parameter specifies the high priority request
105f11c7f63SJim Harris * queue object for which to attempt to remove elements.
106f11c7f63SJim Harris * @param[in] fw_domain This parameter specifies the domain for which to
107f11c7f63SJim Harris * remove all high priority requests.
108f11c7f63SJim Harris *
109f11c7f63SJim Harris * @return none
110f11c7f63SJim Harris */
scif_sas_high_priority_request_queue_purge_domain(SCIF_SAS_HIGH_PRIORITY_REQUEST_QUEUE_T * fw_hprq,SCIF_SAS_DOMAIN_T * fw_domain)111f11c7f63SJim Harris void scif_sas_high_priority_request_queue_purge_domain(
112f11c7f63SJim Harris SCIF_SAS_HIGH_PRIORITY_REQUEST_QUEUE_T * fw_hprq,
113f11c7f63SJim Harris SCIF_SAS_DOMAIN_T * fw_domain
114f11c7f63SJim Harris )
115f11c7f63SJim Harris {
116f11c7f63SJim Harris SCIF_SAS_IO_REQUEST_T * fw_io;
117f11c7f63SJim Harris POINTER_UINT io_address;
118f11c7f63SJim Harris U32 index;
119f11c7f63SJim Harris U32 element_count;
120f11c7f63SJim Harris
121f11c7f63SJim Harris SCIF_LOG_TRACE((
122f11c7f63SJim Harris sci_base_object_get_logger(&fw_hprq->lock),
123f11c7f63SJim Harris SCIF_LOG_OBJECT_CONTROLLER | SCIF_LOG_OBJECT_DOMAIN_DISCOVERY,
124f11c7f63SJim Harris "scif_sas_high_priority_request_queue_purge_domain(0x%x,0x%x) enter\n",
125f11c7f63SJim Harris fw_hprq, fw_domain
126f11c7f63SJim Harris ));
127f11c7f63SJim Harris
128f11c7f63SJim Harris element_count = sci_pool_count(fw_hprq->pool);
129f11c7f63SJim Harris
130f11c7f63SJim Harris scif_cb_lock_acquire(fw_domain->controller, &fw_hprq->lock);
131f11c7f63SJim Harris
132f11c7f63SJim Harris for (index = 0; index < element_count; index++)
133f11c7f63SJim Harris {
134f11c7f63SJim Harris sci_pool_get(fw_hprq->pool, io_address);
135f11c7f63SJim Harris
136f11c7f63SJim Harris fw_io = (SCIF_SAS_IO_REQUEST_T*) io_address;
137f11c7f63SJim Harris
138f11c7f63SJim Harris // If the high priority request is not intended for this domain,
139f11c7f63SJim Harris // then it can be left in the pool.
140f11c7f63SJim Harris if (fw_io->parent.device->domain != fw_domain)
141f11c7f63SJim Harris {
142f11c7f63SJim Harris sci_pool_put(fw_hprq->pool, io_address);
143f11c7f63SJim Harris }
144f11c7f63SJim Harris else
145f11c7f63SJim Harris {
146f11c7f63SJim Harris if (fw_io->parent.is_internal)
147f11c7f63SJim Harris {
148f11c7f63SJim Harris SCIF_SAS_INTERNAL_IO_REQUEST_T * fw_internal_io =
149f11c7f63SJim Harris (SCIF_SAS_INTERNAL_IO_REQUEST_T *)fw_io;
150f11c7f63SJim Harris
151f11c7f63SJim Harris // The request was intended for a device in the domain. Put it
152f11c7f63SJim Harris // back in the pool of freely available internal request memory
153f11c7f63SJim Harris // objects. The internal IO's timer is to be destoyed.
154f11c7f63SJim Harris scif_sas_internal_io_request_destruct(fw_domain->controller, fw_internal_io);
155f11c7f63SJim Harris }
156f11c7f63SJim Harris }
157f11c7f63SJim Harris }
158f11c7f63SJim Harris
159f11c7f63SJim Harris scif_cb_lock_release(fw_domain->controller, &fw_hprq->lock);
160f11c7f63SJim Harris }
161f11c7f63SJim Harris
162