1230557Sjimharris/*- 2230557Sjimharris * This file is provided under a dual BSD/GPLv2 license. When using or 3230557Sjimharris * redistributing this file, you may do so under either license. 4230557Sjimharris * 5230557Sjimharris * GPL LICENSE SUMMARY 6230557Sjimharris * 7230557Sjimharris * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved. 8230557Sjimharris * 9230557Sjimharris * This program is free software; you can redistribute it and/or modify 10230557Sjimharris * it under the terms of version 2 of the GNU General Public License as 11230557Sjimharris * published by the Free Software Foundation. 12230557Sjimharris * 13230557Sjimharris * This program is distributed in the hope that it will be useful, but 14230557Sjimharris * WITHOUT ANY WARRANTY; without even the implied warranty of 15230557Sjimharris * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 16230557Sjimharris * General Public License for more details. 17230557Sjimharris * 18230557Sjimharris * You should have received a copy of the GNU General Public License 19230557Sjimharris * along with this program; if not, write to the Free Software 20230557Sjimharris * Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA. 21230557Sjimharris * The full GNU General Public License is included in this distribution 22230557Sjimharris * in the file called LICENSE.GPL. 23230557Sjimharris * 24230557Sjimharris * BSD LICENSE 25230557Sjimharris * 26230557Sjimharris * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved. 27230557Sjimharris * All rights reserved. 28230557Sjimharris * 29230557Sjimharris * Redistribution and use in source and binary forms, with or without 30230557Sjimharris * modification, are permitted provided that the following conditions 31230557Sjimharris * are met: 32230557Sjimharris * 33230557Sjimharris * * Redistributions of source code must retain the above copyright 34230557Sjimharris * notice, this list of conditions and the following disclaimer. 35230557Sjimharris * * Redistributions in binary form must reproduce the above copyright 36230557Sjimharris * notice, this list of conditions and the following disclaimer in 37230557Sjimharris * the documentation and/or other materials provided with the 38230557Sjimharris * distribution. 39230557Sjimharris * 40230557Sjimharris * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 41230557Sjimharris * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 42230557Sjimharris * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 43230557Sjimharris * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 44230557Sjimharris * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 45230557Sjimharris * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 46230557Sjimharris * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 47230557Sjimharris * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 48230557Sjimharris * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 49230557Sjimharris * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 50230557Sjimharris * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 51230557Sjimharris * 52230557Sjimharris * $FreeBSD$ 53230557Sjimharris */ 54230557Sjimharris#ifndef _SCIF_SAS_HIGH_PRIORITY_REQUEST_QUEUE_H_ 55230557Sjimharris#define _SCIF_SAS_HIGH_PRIORITY_REQUEST_QUEUE_H_ 56230557Sjimharris 57230557Sjimharris/** 58230557Sjimharris * @file 59230557Sjimharris * 60230557Sjimharris * @brief This file contains all of method prototypes and type 61230557Sjimharris * definitions specific to the high priority request queue (HPRQ). 62230557Sjimharris * The HPRQ is the mechanism through which internal requests or 63230557Sjimharris * other important requests created by the framework are stored. 64230557Sjimharris * The HPRQ is checked during the scif_controller_start_io() path 65230557Sjimharris * and is given precedence over user supplied IO requests. 66230557Sjimharris * Additionally, when requests are created there is an attempt to 67230557Sjimharris * start them quickly. 68230557Sjimharris */ 69230557Sjimharris 70230557Sjimharris#ifdef __cplusplus 71230557Sjimharrisextern "C" { 72230557Sjimharris#endif // __cplusplus 73230557Sjimharris 74230557Sjimharris#include <dev/isci/scil/sci_types.h> 75230557Sjimharris#include <dev/isci/scil/sci_base_object.h> 76230557Sjimharris#include <dev/isci/scil/sci_pool.h> 77230557Sjimharris#include <dev/isci/scil/scif_sas_domain.h> 78230557Sjimharris#include <dev/isci/scil/scif_sas_internal_io_request.h> 79230557Sjimharris 80230557Sjimharristypedef struct SCIF_SAS_LOCK 81230557Sjimharris{ 82230557Sjimharris SCI_BASE_OBJECT_T parent; 83230557Sjimharris 84230557Sjimharris SCI_LOCK_LEVEL level; 85230557Sjimharris 86230557Sjimharris} SCIF_SAS_LOCK_T; 87230557Sjimharris 88230557Sjimharris/** 89230557Sjimharris * @struct SCIF_SAS_HIGH_PRIORITY_REQUEST_QUEUE_T 90230557Sjimharris * 91230557Sjimharris * @brief This structure depicts the fields contain in the high 92230557Sjimharris * priority request queue (HPRQ) object. The HPRQ is used 93230557Sjimharris * to store IO or task requests that need to be completed 94230557Sjimharris * in short order. 95230557Sjimharris */ 96230557Sjimharristypedef struct SCIF_SAS_HIGH_PRIORITY_REQUEST_QUEUE 97230557Sjimharris{ 98230557Sjimharris /** 99230557Sjimharris * This field specifies the necessary lock information (e.g. level) 100230557Sjimharris * that must be taken before items are added or removed from the 101230557Sjimharris * queue. 102230557Sjimharris */ 103230557Sjimharris SCIF_SAS_LOCK_T lock; 104230557Sjimharris 105230557Sjimharris SCI_POOL_CREATE(pool, POINTER_UINT, SCIF_SAS_MAX_INTERNAL_REQUEST_COUNT); 106230557Sjimharris 107230557Sjimharris} SCIF_SAS_HIGH_PRIORITY_REQUEST_QUEUE_T; 108230557Sjimharris 109230557Sjimharrisvoid scif_sas_high_priority_request_queue_construct( 110230557Sjimharris SCIF_SAS_HIGH_PRIORITY_REQUEST_QUEUE_T * fw_hprq, 111230557Sjimharris SCI_BASE_LOGGER_T * logger 112230557Sjimharris); 113230557Sjimharris 114230557Sjimharrisvoid scif_sas_high_priority_request_queue_purge_domain( 115230557Sjimharris SCIF_SAS_HIGH_PRIORITY_REQUEST_QUEUE_T * fw_hprq, 116230557Sjimharris SCIF_SAS_DOMAIN_T * fw_domain 117230557Sjimharris); 118230557Sjimharris 119230557Sjimharris#ifdef __cplusplus 120230557Sjimharris} 121230557Sjimharris#endif // __cplusplus 122230557Sjimharris 123230557Sjimharris#endif // _SCIF_SAS_HIGH_PRIORITY_REQUEST_QUEUE_H_ 124