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 _SCIF_TASK_REQUEST_H_ 55 #define _SCIF_TASK_REQUEST_H_ 56 57 /** 58 * @file 59 * 60 * @brief This file contains the structures and interface methods that 61 * can be referenced and used by the SCI user for the SCI task 62 * management request object. 63 */ 64 65 #ifdef __cplusplus 66 extern "C" { 67 #endif // __cplusplus 68 69 #include <dev/isci/scil/sci_types.h> 70 #include <dev/isci/scil/sci_status.h> 71 72 73 /** 74 * @brief This method simply returns the size required to construct an SCI 75 * based task request object (includes core & framework object size). 76 * 77 * @return Retrun the size of the SCI task request object. 78 */ 79 U32 scif_task_request_get_object_size( 80 void 81 ); 82 83 /** 84 * @brief This method is called by the SCIF user to construct a task 85 * management request. This method will construct a SCIC task request 86 * internally. 87 * 88 * @note The SCI framework implementation will create an association between 89 * the user task request object and the framework task request object. 90 * 91 * @param[in] scif_controller the handle to the framework controller object 92 * for which to build an IO request. 93 * @param[in] scif_remote_device This parameter specifies the framework 94 * remote device with which this task request is to be associated. 95 * @param[in] io_tag This parameter specifies the IO tag to be associated 96 * with this request. If SCI_CONTROLLER_INVALID_IO_TAG is 97 * passed, then a copy of the request is built internally. The 98 * request will be copied into the actual controller request 99 * memory when the IO tag is allocated internally during the 100 * scif_controller_start_task() method. 101 * @param[in] user_task_request_object This parameter specifies the user 102 * task request to be utilized during task construction. This task 103 * pointer will become the associated object for the framework 104 * task request object. 105 * @param[in] task_request_memory This parameter specifies the memory 106 * to be utilized in the construction of the framework task request. 107 * @param[in] scif_task_request This parameter specifies the handle to be 108 * utilized for all further interactions with this task request 109 * object. 110 * 111 * @return Indicate if the controller successfully built the task request. 112 * @retval SCI_SUCCESS This value is returned if the task request was 113 * successfully built. 114 */ 115 SCI_STATUS scif_task_request_construct( 116 SCI_CONTROLLER_HANDLE_T scif_controller, 117 SCI_REMOTE_DEVICE_HANDLE_T scif_remote_device, 118 U16 io_tag, 119 void * user_task_request_object, 120 void * task_request_memory, 121 SCI_TASK_REQUEST_HANDLE_T * scif_task_request 122 ); 123 124 #ifdef __cplusplus 125 } 126 #endif // __cplusplus 127 128 #endif // _SCIF_TASK_REQUEST_H_ 129 130