1/*- 2 * This file is provided under a dual BSD/GPLv2 license. When using or 3 * redistributing this file, you may do so under either license. 4 * 5 * GPL LICENSE SUMMARY 6 * 7 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved. 8 * 9 * This program is free software; you can redistribute it and/or modify 10 * it under the terms of version 2 of the GNU General Public License as 11 * published by the Free Software Foundation. 12 * 13 * This program is distributed in the hope that it will be useful, but 14 * WITHOUT ANY WARRANTY; without even the implied warranty of 15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 16 * General Public License for more details. 17 * 18 * You should have received a copy of the GNU General Public License 19 * along with this program; if not, write to the Free Software 20 * Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA. 21 * The full GNU General Public License is included in this distribution 22 * in the file called LICENSE.GPL. 23 * 24 * BSD LICENSE 25 * 26 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved. 27 * All rights reserved. 28 * 29 * Redistribution and use in source and binary forms, with or without 30 * modification, are permitted provided that the following conditions 31 * are met: 32 * 33 * * Redistributions of source code must retain the above copyright 34 * notice, this list of conditions and the following disclaimer. 35 * * Redistributions in binary form must reproduce the above copyright 36 * notice, this list of conditions and the following disclaimer in 37 * the documentation and/or other materials provided with the 38 * distribution. 39 * 40 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 41 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 42 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 43 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 44 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 45 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 46 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 47 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 48 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 49 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 50 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 51 * 52 * $FreeBSD$ 53 */ 54#ifndef _SCIF_SAS_HIGH_PRIORITY_REQUEST_QUEUE_H_ 55#define _SCIF_SAS_HIGH_PRIORITY_REQUEST_QUEUE_H_ 56 57/** 58 * @file 59 * 60 * @brief This file contains all of method prototypes and type 61 * definitions specific to the high priority request queue (HPRQ). 62 * The HPRQ is the mechanism through which internal requests or 63 * other important requests created by the framework are stored. 64 * The HPRQ is checked during the scif_controller_start_io() path 65 * and is given precedence over user supplied IO requests. 66 * Additionally, when requests are created there is an attempt to 67 * start them quickly. 68 */ 69 70#ifdef __cplusplus 71extern "C" { 72#endif // __cplusplus 73 74#include <dev/isci/scil/sci_types.h> 75#include <dev/isci/scil/sci_base_object.h> 76#include <dev/isci/scil/sci_pool.h> 77#include <dev/isci/scil/scif_sas_domain.h> 78#include <dev/isci/scil/scif_sas_internal_io_request.h> 79 80typedef struct SCIF_SAS_LOCK 81{ 82 SCI_BASE_OBJECT_T parent; 83 84 SCI_LOCK_LEVEL level; 85 86} SCIF_SAS_LOCK_T; 87 88/** 89 * @struct SCIF_SAS_HIGH_PRIORITY_REQUEST_QUEUE_T 90 * 91 * @brief This structure depicts the fields contain in the high 92 * priority request queue (HPRQ) object. The HPRQ is used 93 * to store IO or task requests that need to be completed 94 * in short order. 95 */ 96typedef struct SCIF_SAS_HIGH_PRIORITY_REQUEST_QUEUE 97{ 98 /** 99 * This field specifies the necessary lock information (e.g. level) 100 * that must be taken before items are added or removed from the 101 * queue. 102 */ 103 SCIF_SAS_LOCK_T lock; 104 105 SCI_POOL_CREATE(pool, POINTER_UINT, SCIF_SAS_MAX_INTERNAL_REQUEST_COUNT); 106 107} SCIF_SAS_HIGH_PRIORITY_REQUEST_QUEUE_T; 108 109void scif_sas_high_priority_request_queue_construct( 110 SCIF_SAS_HIGH_PRIORITY_REQUEST_QUEUE_T * fw_hprq, 111 SCI_BASE_LOGGER_T * logger 112); 113 114void scif_sas_high_priority_request_queue_purge_domain( 115 SCIF_SAS_HIGH_PRIORITY_REQUEST_QUEUE_T * fw_hprq, 116 SCIF_SAS_DOMAIN_T * fw_domain 117); 118 119#ifdef __cplusplus 120} 121#endif // __cplusplus 122 123#endif // _SCIF_SAS_HIGH_PRIORITY_REQUEST_QUEUE_H_ 124