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_HIGH_PRIORITY_REQUEST_QUEUE_H_ 57 #define _SCIF_SAS_HIGH_PRIORITY_REQUEST_QUEUE_H_ 58 59 /** 60 * @file 61 * 62 * @brief This file contains all of method prototypes and type 63 * definitions specific to the high priority request queue (HPRQ). 64 * The HPRQ is the mechanism through which internal requests or 65 * other important requests created by the framework are stored. 66 * The HPRQ is checked during the scif_controller_start_io() path 67 * and is given precedence over user supplied IO requests. 68 * Additionally, when requests are created there is an attempt to 69 * start them quickly. 70 */ 71 72 #ifdef __cplusplus 73 extern "C" { 74 #endif // __cplusplus 75 76 #include <dev/isci/scil/sci_types.h> 77 #include <dev/isci/scil/sci_base_object.h> 78 #include <dev/isci/scil/sci_pool.h> 79 #include <dev/isci/scil/scif_sas_domain.h> 80 #include <dev/isci/scil/scif_sas_internal_io_request.h> 81 82 typedef struct SCIF_SAS_LOCK 83 { 84 SCI_BASE_OBJECT_T parent; 85 86 SCI_LOCK_LEVEL level; 87 88 } SCIF_SAS_LOCK_T; 89 90 /** 91 * @struct SCIF_SAS_HIGH_PRIORITY_REQUEST_QUEUE_T 92 * 93 * @brief This structure depicts the fields contain in the high 94 * priority request queue (HPRQ) object. The HPRQ is used 95 * to store IO or task requests that need to be completed 96 * in short order. 97 */ 98 typedef struct SCIF_SAS_HIGH_PRIORITY_REQUEST_QUEUE 99 { 100 /** 101 * This field specifies the necessary lock information (e.g. level) 102 * that must be taken before items are added or removed from the 103 * queue. 104 */ 105 SCIF_SAS_LOCK_T lock; 106 107 SCI_POOL_CREATE(pool, POINTER_UINT, SCIF_SAS_MAX_INTERNAL_REQUEST_COUNT); 108 109 } SCIF_SAS_HIGH_PRIORITY_REQUEST_QUEUE_T; 110 111 void scif_sas_high_priority_request_queue_construct( 112 SCIF_SAS_HIGH_PRIORITY_REQUEST_QUEUE_T * fw_hprq, 113 SCI_BASE_LOGGER_T * logger 114 ); 115 116 void scif_sas_high_priority_request_queue_purge_domain( 117 SCIF_SAS_HIGH_PRIORITY_REQUEST_QUEUE_T * fw_hprq, 118 SCIF_SAS_DOMAIN_T * fw_domain 119 ); 120 121 #ifdef __cplusplus 122 } 123 #endif // __cplusplus 124 125 #endif // _SCIF_SAS_HIGH_PRIORITY_REQUEST_QUEUE_H_ 126