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_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
66extern "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 */
79U32 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 */
115SCI_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