xref: /openbmc/linux/drivers/scsi/isci/request.h (revision f1f52e75939b56c40b3d153ae99faf2720250242)
16f231ddaSDan Williams /*
26f231ddaSDan Williams  * This file is provided under a dual BSD/GPLv2 license.  When using or
36f231ddaSDan Williams  * redistributing this file, you may do so under either license.
46f231ddaSDan Williams  *
56f231ddaSDan Williams  * GPL LICENSE SUMMARY
66f231ddaSDan Williams  *
76f231ddaSDan Williams  * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
86f231ddaSDan Williams  *
96f231ddaSDan Williams  * This program is free software; you can redistribute it and/or modify
106f231ddaSDan Williams  * it under the terms of version 2 of the GNU General Public License as
116f231ddaSDan Williams  * published by the Free Software Foundation.
126f231ddaSDan Williams  *
136f231ddaSDan Williams  * This program is distributed in the hope that it will be useful, but
146f231ddaSDan Williams  * WITHOUT ANY WARRANTY; without even the implied warranty of
156f231ddaSDan Williams  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
166f231ddaSDan Williams  * General Public License for more details.
176f231ddaSDan Williams  *
186f231ddaSDan Williams  * You should have received a copy of the GNU General Public License
196f231ddaSDan Williams  * along with this program; if not, write to the Free Software
206f231ddaSDan Williams  * Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
216f231ddaSDan Williams  * The full GNU General Public License is included in this distribution
226f231ddaSDan Williams  * in the file called LICENSE.GPL.
236f231ddaSDan Williams  *
246f231ddaSDan Williams  * BSD LICENSE
256f231ddaSDan Williams  *
266f231ddaSDan Williams  * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
276f231ddaSDan Williams  * All rights reserved.
286f231ddaSDan Williams  *
296f231ddaSDan Williams  * Redistribution and use in source and binary forms, with or without
306f231ddaSDan Williams  * modification, are permitted provided that the following conditions
316f231ddaSDan Williams  * are met:
326f231ddaSDan Williams  *
336f231ddaSDan Williams  *   * Redistributions of source code must retain the above copyright
346f231ddaSDan Williams  *     notice, this list of conditions and the following disclaimer.
356f231ddaSDan Williams  *   * Redistributions in binary form must reproduce the above copyright
366f231ddaSDan Williams  *     notice, this list of conditions and the following disclaimer in
376f231ddaSDan Williams  *     the documentation and/or other materials provided with the
386f231ddaSDan Williams  *     distribution.
396f231ddaSDan Williams  *   * Neither the name of Intel Corporation nor the names of its
406f231ddaSDan Williams  *     contributors may be used to endorse or promote products derived
416f231ddaSDan Williams  *     from this software without specific prior written permission.
426f231ddaSDan Williams  *
436f231ddaSDan Williams  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
446f231ddaSDan Williams  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
456f231ddaSDan Williams  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
466f231ddaSDan Williams  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
476f231ddaSDan Williams  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
486f231ddaSDan Williams  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
496f231ddaSDan Williams  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
506f231ddaSDan Williams  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
516f231ddaSDan Williams  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
526f231ddaSDan Williams  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
536f231ddaSDan Williams  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
546f231ddaSDan Williams  */
556f231ddaSDan Williams 
560d84366fSDan Williams #ifndef _ISCI_REQUEST_H_
576f231ddaSDan Williams #define _ISCI_REQUEST_H_
586f231ddaSDan Williams 
596f231ddaSDan Williams #include "isci.h"
60ce2b3261SDan Williams #include "host.h"
61*f1f52e75SDan Williams #include "scu_task_context.h"
62*f1f52e75SDan Williams #include "stp_request.h"
636f231ddaSDan Williams 
646f231ddaSDan Williams /**
656f231ddaSDan Williams  * struct isci_request_status - This enum defines the possible states of an I/O
666f231ddaSDan Williams  *    request.
676f231ddaSDan Williams  *
686f231ddaSDan Williams  *
696f231ddaSDan Williams  */
706f231ddaSDan Williams enum isci_request_status {
716f231ddaSDan Williams 	unallocated = 0x00,
726f231ddaSDan Williams 	allocated   = 0x01,
736f231ddaSDan Williams 	started     = 0x02,
746f231ddaSDan Williams 	completed   = 0x03,
756f231ddaSDan Williams 	aborting    = 0x04,
766f231ddaSDan Williams 	aborted     = 0x05,
774dc043c4SJeff Skirvin 	terminating = 0x06,
784dc043c4SJeff Skirvin 	dead        = 0x07
796f231ddaSDan Williams };
806f231ddaSDan Williams 
816f231ddaSDan Williams enum task_type {
826f231ddaSDan Williams 	io_task  = 0,
836f231ddaSDan Williams 	tmf_task = 1
846f231ddaSDan Williams };
856f231ddaSDan Williams 
86*f1f52e75SDan Williams enum sci_request_protocol {
87*f1f52e75SDan Williams 	SCIC_NO_PROTOCOL,
88*f1f52e75SDan Williams 	SCIC_SMP_PROTOCOL,
89*f1f52e75SDan Williams 	SCIC_SSP_PROTOCOL,
90*f1f52e75SDan Williams 	SCIC_STP_PROTOCOL
91*f1f52e75SDan Williams }; /* XXX remove me, use sas_task.dev instead */;
92*f1f52e75SDan Williams 
93*f1f52e75SDan Williams struct scic_sds_request {
94*f1f52e75SDan Williams 	/**
95*f1f52e75SDan Williams 	 * This field contains the information for the base request state machine.
96*f1f52e75SDan Williams 	 */
97*f1f52e75SDan Williams 	struct sci_base_state_machine state_machine;
98*f1f52e75SDan Williams 
99*f1f52e75SDan Williams 	/**
100*f1f52e75SDan Williams 	 * This field simply points to the controller to which this IO request
101*f1f52e75SDan Williams 	 * is associated.
102*f1f52e75SDan Williams 	 */
103*f1f52e75SDan Williams 	struct scic_sds_controller *owning_controller;
104*f1f52e75SDan Williams 
105*f1f52e75SDan Williams 	/**
106*f1f52e75SDan Williams 	 * This field simply points to the remote device to which this IO request
107*f1f52e75SDan Williams 	 * is associated.
108*f1f52e75SDan Williams 	 */
109*f1f52e75SDan Williams 	struct scic_sds_remote_device *target_device;
110*f1f52e75SDan Williams 
111*f1f52e75SDan Williams 	/**
112*f1f52e75SDan Williams 	 * This field is utilized to determine if the SCI user is managing
113*f1f52e75SDan Williams 	 * the IO tag for this request or if the core is managing it.
114*f1f52e75SDan Williams 	 */
115*f1f52e75SDan Williams 	bool was_tag_assigned_by_user;
116*f1f52e75SDan Williams 
117*f1f52e75SDan Williams 	/**
118*f1f52e75SDan Williams 	 * This field indicates the IO tag for this request.  The IO tag is
119*f1f52e75SDan Williams 	 * comprised of the task_index and a sequence count. The sequence count
120*f1f52e75SDan Williams 	 * is utilized to help identify tasks from one life to another.
121*f1f52e75SDan Williams 	 */
122*f1f52e75SDan Williams 	u16 io_tag;
123*f1f52e75SDan Williams 
124*f1f52e75SDan Williams 	/**
125*f1f52e75SDan Williams 	 * This field specifies the protocol being utilized for this
126*f1f52e75SDan Williams 	 * IO request.
127*f1f52e75SDan Williams 	 */
128*f1f52e75SDan Williams 	enum sci_request_protocol protocol;
129*f1f52e75SDan Williams 
130*f1f52e75SDan Williams 	/**
131*f1f52e75SDan Williams 	 * This field indicates the completion status taken from the SCUs
132*f1f52e75SDan Williams 	 * completion code.  It indicates the completion result for the SCU hardware.
133*f1f52e75SDan Williams 	 */
134*f1f52e75SDan Williams 	u32 scu_status;
135*f1f52e75SDan Williams 
136*f1f52e75SDan Williams 	/**
137*f1f52e75SDan Williams 	 * This field indicates the completion status returned to the SCI user.  It
138*f1f52e75SDan Williams 	 * indicates the users view of the io request completion.
139*f1f52e75SDan Williams 	 */
140*f1f52e75SDan Williams 	u32 sci_status;
141*f1f52e75SDan Williams 
142*f1f52e75SDan Williams 	/**
143*f1f52e75SDan Williams 	 * This field contains the value to be utilized when posting (e.g. Post_TC,
144*f1f52e75SDan Williams 	 * Post_TC_Abort) this request to the silicon.
145*f1f52e75SDan Williams 	 */
146*f1f52e75SDan Williams 	u32 post_context;
147*f1f52e75SDan Williams 
148*f1f52e75SDan Williams 	struct scu_task_context *task_context_buffer;
149*f1f52e75SDan Williams 	struct scu_task_context tc ____cacheline_aligned;
150*f1f52e75SDan Williams 
151*f1f52e75SDan Williams 	/* could be larger with sg chaining */
152*f1f52e75SDan Williams 	#define SCU_SGL_SIZE ((SCU_IO_REQUEST_SGE_COUNT + 1) / 2)
153*f1f52e75SDan Williams 	struct scu_sgl_element_pair sg_table[SCU_SGL_SIZE] __attribute__ ((aligned(32)));
154*f1f52e75SDan Williams 
155*f1f52e75SDan Williams 	/**
156*f1f52e75SDan Williams 	 * This field indicates if this request is a task management request or
157*f1f52e75SDan Williams 	 * normal IO request.
158*f1f52e75SDan Williams 	 */
159*f1f52e75SDan Williams 	bool is_task_management_request;
160*f1f52e75SDan Williams 
161*f1f52e75SDan Williams 	/**
162*f1f52e75SDan Williams 	 * This field indicates that this request contains an initialized started
163*f1f52e75SDan Williams 	 * substate machine.
164*f1f52e75SDan Williams 	 */
165*f1f52e75SDan Williams 	bool has_started_substate_machine;
166*f1f52e75SDan Williams 
167*f1f52e75SDan Williams 	/**
168*f1f52e75SDan Williams 	 * This field is a pointer to the stored rx frame data.  It is used in STP
169*f1f52e75SDan Williams 	 * internal requests and SMP response frames.  If this field is non-NULL the
170*f1f52e75SDan Williams 	 * saved frame must be released on IO request completion.
171*f1f52e75SDan Williams 	 *
172*f1f52e75SDan Williams 	 * @todo In the future do we want to keep a list of RX frame buffers?
173*f1f52e75SDan Williams 	 */
174*f1f52e75SDan Williams 	u32 saved_rx_frame_index;
175*f1f52e75SDan Williams 
176*f1f52e75SDan Williams 	/**
177*f1f52e75SDan Williams 	 * This field specifies the data necessary to manage the sub-state
178*f1f52e75SDan Williams 	 * machine executed while in the SCI_BASE_REQUEST_STATE_STARTED state.
179*f1f52e75SDan Williams 	 */
180*f1f52e75SDan Williams 	struct sci_base_state_machine started_substate_machine;
181*f1f52e75SDan Williams 
182*f1f52e75SDan Williams 	/**
183*f1f52e75SDan Williams 	 * This field specifies the current state handlers in place for this
184*f1f52e75SDan Williams 	 * IO Request object.  This field is updated each time the request
185*f1f52e75SDan Williams 	 * changes state.
186*f1f52e75SDan Williams 	 */
187*f1f52e75SDan Williams 	const struct scic_sds_io_request_state_handler *state_handlers;
188*f1f52e75SDan Williams 
189*f1f52e75SDan Williams 	/**
190*f1f52e75SDan Williams 	 * This field in the recorded device sequence for the io request.  This is
191*f1f52e75SDan Williams 	 * recorded during the build operation and is compared in the start
192*f1f52e75SDan Williams 	 * operation.  If the sequence is different then there was a change of
193*f1f52e75SDan Williams 	 * devices from the build to start operations.
194*f1f52e75SDan Williams 	 */
195*f1f52e75SDan Williams 	u8 device_sequence;
196*f1f52e75SDan Williams 
197*f1f52e75SDan Williams 	union {
198*f1f52e75SDan Williams 		struct {
199*f1f52e75SDan Williams 			union {
200*f1f52e75SDan Williams 				struct ssp_cmd_iu cmd;
201*f1f52e75SDan Williams 				struct ssp_task_iu tmf;
202*f1f52e75SDan Williams 			};
203*f1f52e75SDan Williams 			union {
204*f1f52e75SDan Williams 				struct ssp_response_iu rsp;
205*f1f52e75SDan Williams 				u8 rsp_buf[SSP_RESP_IU_MAX_SIZE];
206*f1f52e75SDan Williams 			};
207*f1f52e75SDan Williams 		} ssp;
208*f1f52e75SDan Williams 
209*f1f52e75SDan Williams 		struct {
210*f1f52e75SDan Williams 			struct smp_req cmd;
211*f1f52e75SDan Williams 			struct smp_resp rsp;
212*f1f52e75SDan Williams 		} smp;
213*f1f52e75SDan Williams 
214*f1f52e75SDan Williams 		struct {
215*f1f52e75SDan Williams 			struct scic_sds_stp_request req;
216*f1f52e75SDan Williams 			struct host_to_dev_fis cmd;
217*f1f52e75SDan Williams 			struct dev_to_host_fis rsp;
218*f1f52e75SDan Williams 		} stp;
219*f1f52e75SDan Williams 	};
220*f1f52e75SDan Williams 
221*f1f52e75SDan Williams };
222*f1f52e75SDan Williams 
223*f1f52e75SDan Williams static inline struct scic_sds_request *to_sci_req(struct scic_sds_stp_request *stp_req)
224*f1f52e75SDan Williams {
225*f1f52e75SDan Williams 	struct scic_sds_request *sci_req;
226*f1f52e75SDan Williams 
227*f1f52e75SDan Williams 	sci_req = container_of(stp_req, typeof(*sci_req), stp.req);
228*f1f52e75SDan Williams 	return sci_req;
229*f1f52e75SDan Williams }
230*f1f52e75SDan Williams 
2316f231ddaSDan Williams struct isci_request {
2326f231ddaSDan Williams 	enum isci_request_status status;
2336f231ddaSDan Williams 	enum task_type ttype;
2346f231ddaSDan Williams 	unsigned short io_tag;
2356f231ddaSDan Williams 	bool complete_in_target;
23667ea838dSDan Williams 	bool terminated;
2376f231ddaSDan Williams 
2386f231ddaSDan Williams 	union ttype_ptr_union {
2396f231ddaSDan Williams 		struct sas_task *io_task_ptr;   /* When ttype==io_task  */
2406f231ddaSDan Williams 		struct isci_tmf *tmf_task_ptr;  /* When ttype==tmf_task */
2416f231ddaSDan Williams 	} ttype_ptr;
2426f231ddaSDan Williams 	struct isci_host *isci_host;
2436f231ddaSDan Williams 	struct isci_remote_device *isci_device;
2446f231ddaSDan Williams 	/* For use in the requests_to_{complete|abort} lists: */
2456f231ddaSDan Williams 	struct list_head completed_node;
2466f231ddaSDan Williams 	/* For use in the reqs_in_process list: */
2476f231ddaSDan Williams 	struct list_head dev_node;
2486f231ddaSDan Williams 	spinlock_t state_lock;
2496f231ddaSDan Williams 	dma_addr_t request_daddr;
2506f231ddaSDan Williams 	dma_addr_t zero_scatter_daddr;
2516f231ddaSDan Williams 
2526f231ddaSDan Williams 	unsigned int num_sg_entries;                    /* returned by pci_alloc_sg */
2536f231ddaSDan Williams 
2546f231ddaSDan Williams 	/** Note: "io_request_completion" is completed in two different ways
2556f231ddaSDan Williams 	 * depending on whether this is a TMF or regular request.
2566f231ddaSDan Williams 	 * - TMF requests are completed in the thread that started them;
2576f231ddaSDan Williams 	 * - regular requests are completed in the request completion callback
2586f231ddaSDan Williams 	 *   function.
2596f231ddaSDan Williams 	 * This difference in operation allows the aborter of a TMF request
2606f231ddaSDan Williams 	 * to be sure that once the TMF request completes, the I/O that the
2616f231ddaSDan Williams 	 * TMF was aborting is guaranteed to have completed.
2626f231ddaSDan Williams 	 */
2636f231ddaSDan Williams 	struct completion *io_request_completion;
26467ea838dSDan Williams 	struct scic_sds_request sci;
2656f231ddaSDan Williams };
2666f231ddaSDan Williams 
26767ea838dSDan Williams static inline struct isci_request *sci_req_to_ireq(struct scic_sds_request *sci_req)
26867ea838dSDan Williams {
26967ea838dSDan Williams 	struct isci_request *ireq = container_of(sci_req, typeof(*ireq), sci);
27067ea838dSDan Williams 
27167ea838dSDan Williams 	return ireq;
27267ea838dSDan Williams }
27367ea838dSDan Williams 
2746f231ddaSDan Williams /**
275*f1f52e75SDan Williams  * enum sci_base_request_states - This enumeration depicts all the states for
276*f1f52e75SDan Williams  *    the common request state machine.
277*f1f52e75SDan Williams  *
278*f1f52e75SDan Williams  *
279*f1f52e75SDan Williams  */
280*f1f52e75SDan Williams enum sci_base_request_states {
281*f1f52e75SDan Williams 	/**
282*f1f52e75SDan Williams 	 * Simply the initial state for the base request state machine.
283*f1f52e75SDan Williams 	 */
284*f1f52e75SDan Williams 	SCI_BASE_REQUEST_STATE_INITIAL,
285*f1f52e75SDan Williams 
286*f1f52e75SDan Williams 	/**
287*f1f52e75SDan Williams 	 * This state indicates that the request has been constructed. This state
288*f1f52e75SDan Williams 	 * is entered from the INITIAL state.
289*f1f52e75SDan Williams 	 */
290*f1f52e75SDan Williams 	SCI_BASE_REQUEST_STATE_CONSTRUCTED,
291*f1f52e75SDan Williams 
292*f1f52e75SDan Williams 	/**
293*f1f52e75SDan Williams 	 * This state indicates that the request has been started. This state is
294*f1f52e75SDan Williams 	 * entered from the CONSTRUCTED state.
295*f1f52e75SDan Williams 	 */
296*f1f52e75SDan Williams 	SCI_BASE_REQUEST_STATE_STARTED,
297*f1f52e75SDan Williams 
298*f1f52e75SDan Williams 	/**
299*f1f52e75SDan Williams 	 * This state indicates that the request has completed.
300*f1f52e75SDan Williams 	 * This state is entered from the STARTED state. This state is entered from
301*f1f52e75SDan Williams 	 * the ABORTING state.
302*f1f52e75SDan Williams 	 */
303*f1f52e75SDan Williams 	SCI_BASE_REQUEST_STATE_COMPLETED,
304*f1f52e75SDan Williams 
305*f1f52e75SDan Williams 	/**
306*f1f52e75SDan Williams 	 * This state indicates that the request is in the process of being
307*f1f52e75SDan Williams 	 * terminated/aborted.
308*f1f52e75SDan Williams 	 * This state is entered from the CONSTRUCTED state.
309*f1f52e75SDan Williams 	 * This state is entered from the STARTED state.
310*f1f52e75SDan Williams 	 */
311*f1f52e75SDan Williams 	SCI_BASE_REQUEST_STATE_ABORTING,
312*f1f52e75SDan Williams 
313*f1f52e75SDan Williams 	/**
314*f1f52e75SDan Williams 	 * Simply the final state for the base request state machine.
315*f1f52e75SDan Williams 	 */
316*f1f52e75SDan Williams 	SCI_BASE_REQUEST_STATE_FINAL,
317*f1f52e75SDan Williams };
318*f1f52e75SDan Williams 
319*f1f52e75SDan Williams typedef enum sci_status (*scic_sds_io_request_handler_t)
320*f1f52e75SDan Williams 				(struct scic_sds_request *request);
321*f1f52e75SDan Williams typedef enum sci_status (*scic_sds_io_request_frame_handler_t)
322*f1f52e75SDan Williams 				(struct scic_sds_request *req, u32 frame);
323*f1f52e75SDan Williams typedef enum sci_status (*scic_sds_io_request_event_handler_t)
324*f1f52e75SDan Williams 				(struct scic_sds_request *req, u32 event);
325*f1f52e75SDan Williams typedef enum sci_status (*scic_sds_io_request_task_completion_handler_t)
326*f1f52e75SDan Williams 				(struct scic_sds_request *req, u32 completion_code);
327*f1f52e75SDan Williams 
328*f1f52e75SDan Williams /**
329*f1f52e75SDan Williams  * struct scic_sds_io_request_state_handler - This is the SDS core definition
330*f1f52e75SDan Williams  *    of the state handlers.
331*f1f52e75SDan Williams  *
332*f1f52e75SDan Williams  *
333*f1f52e75SDan Williams  */
334*f1f52e75SDan Williams struct scic_sds_io_request_state_handler {
335*f1f52e75SDan Williams 	/**
336*f1f52e75SDan Williams 	 * The start_handler specifies the method invoked when a user attempts to
337*f1f52e75SDan Williams 	 * start a request.
338*f1f52e75SDan Williams 	 */
339*f1f52e75SDan Williams 	scic_sds_io_request_handler_t start_handler;
340*f1f52e75SDan Williams 
341*f1f52e75SDan Williams 	/**
342*f1f52e75SDan Williams 	 * The abort_handler specifies the method invoked when a user attempts to
343*f1f52e75SDan Williams 	 * abort a request.
344*f1f52e75SDan Williams 	 */
345*f1f52e75SDan Williams 	scic_sds_io_request_handler_t abort_handler;
346*f1f52e75SDan Williams 
347*f1f52e75SDan Williams 	/**
348*f1f52e75SDan Williams 	 * The complete_handler specifies the method invoked when a user attempts to
349*f1f52e75SDan Williams 	 * complete a request.
350*f1f52e75SDan Williams 	 */
351*f1f52e75SDan Williams 	scic_sds_io_request_handler_t complete_handler;
352*f1f52e75SDan Williams 
353*f1f52e75SDan Williams 	scic_sds_io_request_task_completion_handler_t tc_completion_handler;
354*f1f52e75SDan Williams 	scic_sds_io_request_event_handler_t event_handler;
355*f1f52e75SDan Williams 	scic_sds_io_request_frame_handler_t frame_handler;
356*f1f52e75SDan Williams 
357*f1f52e75SDan Williams };
358*f1f52e75SDan Williams 
359*f1f52e75SDan Williams extern const struct sci_base_state scic_sds_io_request_started_task_mgmt_substate_table[];
360*f1f52e75SDan Williams 
361*f1f52e75SDan Williams /**
362*f1f52e75SDan Williams  * scic_sds_request_get_controller() -
363*f1f52e75SDan Williams  *
364*f1f52e75SDan Williams  * This macro will return the controller for this io request object
365*f1f52e75SDan Williams  */
366*f1f52e75SDan Williams #define scic_sds_request_get_controller(sci_req) \
367*f1f52e75SDan Williams 	((sci_req)->owning_controller)
368*f1f52e75SDan Williams 
369*f1f52e75SDan Williams /**
370*f1f52e75SDan Williams  * scic_sds_request_get_device() -
371*f1f52e75SDan Williams  *
372*f1f52e75SDan Williams  * This macro will return the device for this io request object
373*f1f52e75SDan Williams  */
374*f1f52e75SDan Williams #define scic_sds_request_get_device(sci_req) \
375*f1f52e75SDan Williams 	((sci_req)->target_device)
376*f1f52e75SDan Williams 
377*f1f52e75SDan Williams /**
378*f1f52e75SDan Williams  * scic_sds_request_get_port() -
379*f1f52e75SDan Williams  *
380*f1f52e75SDan Williams  * This macro will return the port for this io request object
381*f1f52e75SDan Williams  */
382*f1f52e75SDan Williams #define scic_sds_request_get_port(sci_req)	\
383*f1f52e75SDan Williams 	scic_sds_remote_device_get_port(scic_sds_request_get_device(sci_req))
384*f1f52e75SDan Williams 
385*f1f52e75SDan Williams /**
386*f1f52e75SDan Williams  * scic_sds_request_get_post_context() -
387*f1f52e75SDan Williams  *
388*f1f52e75SDan Williams  * This macro returns the constructed post context result for the io request.
389*f1f52e75SDan Williams  */
390*f1f52e75SDan Williams #define scic_sds_request_get_post_context(sci_req)	\
391*f1f52e75SDan Williams 	((sci_req)->post_context)
392*f1f52e75SDan Williams 
393*f1f52e75SDan Williams /**
394*f1f52e75SDan Williams  * scic_sds_request_get_task_context() -
395*f1f52e75SDan Williams  *
396*f1f52e75SDan Williams  * This is a helper macro to return the os handle for this request object.
397*f1f52e75SDan Williams  */
398*f1f52e75SDan Williams #define scic_sds_request_get_task_context(request) \
399*f1f52e75SDan Williams 	((request)->task_context_buffer)
400*f1f52e75SDan Williams 
401*f1f52e75SDan Williams /**
402*f1f52e75SDan Williams  * scic_sds_request_set_status() -
403*f1f52e75SDan Williams  *
404*f1f52e75SDan Williams  * This macro will set the scu hardware status and sci request completion
405*f1f52e75SDan Williams  * status for an io request.
406*f1f52e75SDan Williams  */
407*f1f52e75SDan Williams #define scic_sds_request_set_status(request, scu_status_code, sci_status_code) \
408*f1f52e75SDan Williams 	{ \
409*f1f52e75SDan Williams 		(request)->scu_status = (scu_status_code); \
410*f1f52e75SDan Williams 		(request)->sci_status = (sci_status_code); \
411*f1f52e75SDan Williams 	}
412*f1f52e75SDan Williams 
413*f1f52e75SDan Williams #define scic_sds_request_complete(a_request) \
414*f1f52e75SDan Williams 	((a_request)->state_handlers->complete_handler(a_request))
415*f1f52e75SDan Williams 
416*f1f52e75SDan Williams 
417*f1f52e75SDan Williams extern enum sci_status
418*f1f52e75SDan Williams scic_sds_io_request_tc_completion(struct scic_sds_request *request, u32 completion_code);
419*f1f52e75SDan Williams 
420*f1f52e75SDan Williams /**
421*f1f52e75SDan Williams  * SCU_SGL_ZERO() -
422*f1f52e75SDan Williams  *
423*f1f52e75SDan Williams  * This macro zeros the hardware SGL element data
424*f1f52e75SDan Williams  */
425*f1f52e75SDan Williams #define SCU_SGL_ZERO(scu_sge) \
426*f1f52e75SDan Williams 	{ \
427*f1f52e75SDan Williams 		(scu_sge).length = 0; \
428*f1f52e75SDan Williams 		(scu_sge).address_lower = 0; \
429*f1f52e75SDan Williams 		(scu_sge).address_upper = 0; \
430*f1f52e75SDan Williams 		(scu_sge).address_modifier = 0;	\
431*f1f52e75SDan Williams 	}
432*f1f52e75SDan Williams 
433*f1f52e75SDan Williams /**
434*f1f52e75SDan Williams  * SCU_SGL_COPY() -
435*f1f52e75SDan Williams  *
436*f1f52e75SDan Williams  * This macro copys the SGL Element data from the host os to the hardware SGL
437*f1f52e75SDan Williams  * elment data
438*f1f52e75SDan Williams  */
439*f1f52e75SDan Williams #define SCU_SGL_COPY(scu_sge, os_sge) \
440*f1f52e75SDan Williams 	{ \
441*f1f52e75SDan Williams 		(scu_sge).length = sg_dma_len(sg); \
442*f1f52e75SDan Williams 		(scu_sge).address_upper = \
443*f1f52e75SDan Williams 			upper_32_bits(sg_dma_address(sg)); \
444*f1f52e75SDan Williams 		(scu_sge).address_lower = \
445*f1f52e75SDan Williams 			lower_32_bits(sg_dma_address(sg)); \
446*f1f52e75SDan Williams 		(scu_sge).address_modifier = 0;	\
447*f1f52e75SDan Williams 	}
448*f1f52e75SDan Williams 
449*f1f52e75SDan Williams void scic_sds_request_build_sgl(struct scic_sds_request *sci_req);
450*f1f52e75SDan Williams void scic_sds_stp_request_assign_buffers(struct scic_sds_request *sci_req);
451*f1f52e75SDan Williams void scic_sds_smp_request_assign_buffers(struct scic_sds_request *sci_req);
452*f1f52e75SDan Williams enum sci_status scic_sds_request_start(struct scic_sds_request *sci_req);
453*f1f52e75SDan Williams enum sci_status scic_sds_io_request_terminate(struct scic_sds_request *sci_req);
454*f1f52e75SDan Williams void scic_sds_io_request_copy_response(struct scic_sds_request *sci_req);
455*f1f52e75SDan Williams enum sci_status scic_sds_io_request_event_handler(struct scic_sds_request *sci_req,
456*f1f52e75SDan Williams 						  u32 event_code);
457*f1f52e75SDan Williams enum sci_status scic_sds_io_request_frame_handler(struct scic_sds_request *sci_req,
458*f1f52e75SDan Williams 						  u32 frame_index);
459*f1f52e75SDan Williams enum sci_status scic_sds_task_request_terminate(struct scic_sds_request *sci_req);
460*f1f52e75SDan Williams enum sci_status scic_sds_request_started_state_abort_handler(struct scic_sds_request *sci_req);
461*f1f52e75SDan Williams 
462*f1f52e75SDan Williams /**
463*f1f52e75SDan Williams  * enum _scic_sds_io_request_started_task_mgmt_substates - This enumeration
464*f1f52e75SDan Williams  *    depicts all of the substates for a task management request to be
465*f1f52e75SDan Williams  *    performed in the STARTED super-state.
466*f1f52e75SDan Williams  *
467*f1f52e75SDan Williams  *
468*f1f52e75SDan Williams  */
469*f1f52e75SDan Williams enum scic_sds_raw_request_started_task_mgmt_substates {
470*f1f52e75SDan Williams 	/**
471*f1f52e75SDan Williams 	 * The AWAIT_TC_COMPLETION sub-state indicates that the started raw
472*f1f52e75SDan Williams 	 * task management request is waiting for the transmission of the
473*f1f52e75SDan Williams 	 * initial frame (i.e. command, task, etc.).
474*f1f52e75SDan Williams 	 */
475*f1f52e75SDan Williams 	SCIC_SDS_IO_REQUEST_STARTED_TASK_MGMT_SUBSTATE_AWAIT_TC_COMPLETION,
476*f1f52e75SDan Williams 
477*f1f52e75SDan Williams 	/**
478*f1f52e75SDan Williams 	 * This sub-state indicates that the started task management request
479*f1f52e75SDan Williams 	 * is waiting for the reception of an unsolicited frame
480*f1f52e75SDan Williams 	 * (i.e. response IU).
481*f1f52e75SDan Williams 	 */
482*f1f52e75SDan Williams 	SCIC_SDS_IO_REQUEST_STARTED_TASK_MGMT_SUBSTATE_AWAIT_TC_RESPONSE,
483*f1f52e75SDan Williams };
484*f1f52e75SDan Williams 
485*f1f52e75SDan Williams 
486*f1f52e75SDan Williams /**
487*f1f52e75SDan Williams  * enum _scic_sds_smp_request_started_substates - This enumeration depicts all
488*f1f52e75SDan Williams  *    of the substates for a SMP request to be performed in the STARTED
489*f1f52e75SDan Williams  *    super-state.
490*f1f52e75SDan Williams  *
491*f1f52e75SDan Williams  *
492*f1f52e75SDan Williams  */
493*f1f52e75SDan Williams enum scic_sds_smp_request_started_substates {
494*f1f52e75SDan Williams 	/**
495*f1f52e75SDan Williams 	 * This sub-state indicates that the started task management request
496*f1f52e75SDan Williams 	 * is waiting for the reception of an unsolicited frame
497*f1f52e75SDan Williams 	 * (i.e. response IU).
498*f1f52e75SDan Williams 	 */
499*f1f52e75SDan Williams 	SCIC_SDS_SMP_REQUEST_STARTED_SUBSTATE_AWAIT_RESPONSE,
500*f1f52e75SDan Williams 
501*f1f52e75SDan Williams 	/**
502*f1f52e75SDan Williams 	 * The AWAIT_TC_COMPLETION sub-state indicates that the started SMP request is
503*f1f52e75SDan Williams 	 * waiting for the transmission of the initial frame (i.e. command, task, etc.).
504*f1f52e75SDan Williams 	 */
505*f1f52e75SDan Williams 	SCIC_SDS_SMP_REQUEST_STARTED_SUBSTATE_AWAIT_TC_COMPLETION,
506*f1f52e75SDan Williams };
507*f1f52e75SDan Williams 
508*f1f52e75SDan Williams 
509*f1f52e75SDan Williams 
510*f1f52e75SDan Williams /* XXX open code in caller */
511*f1f52e75SDan Williams static inline void *scic_request_get_virt_addr(struct scic_sds_request *sci_req,
512*f1f52e75SDan Williams 					       dma_addr_t phys_addr)
513*f1f52e75SDan Williams {
514*f1f52e75SDan Williams 	struct isci_request *ireq = sci_req_to_ireq(sci_req);
515*f1f52e75SDan Williams 	dma_addr_t offset;
516*f1f52e75SDan Williams 
517*f1f52e75SDan Williams 	BUG_ON(phys_addr < ireq->request_daddr);
518*f1f52e75SDan Williams 
519*f1f52e75SDan Williams 	offset = phys_addr - ireq->request_daddr;
520*f1f52e75SDan Williams 
521*f1f52e75SDan Williams 	BUG_ON(offset >= sizeof(*ireq));
522*f1f52e75SDan Williams 
523*f1f52e75SDan Williams 	return (char *)ireq + offset;
524*f1f52e75SDan Williams }
525*f1f52e75SDan Williams 
526*f1f52e75SDan Williams /* XXX open code in caller */
527*f1f52e75SDan Williams static inline dma_addr_t scic_io_request_get_dma_addr(struct scic_sds_request *sci_req,
528*f1f52e75SDan Williams 						      void *virt_addr)
529*f1f52e75SDan Williams {
530*f1f52e75SDan Williams 	struct isci_request *ireq = sci_req_to_ireq(sci_req);
531*f1f52e75SDan Williams 
532*f1f52e75SDan Williams 	char *requested_addr = (char *)virt_addr;
533*f1f52e75SDan Williams 	char *base_addr = (char *)ireq;
534*f1f52e75SDan Williams 
535*f1f52e75SDan Williams 	BUG_ON(requested_addr < base_addr);
536*f1f52e75SDan Williams 	BUG_ON((requested_addr - base_addr) >= sizeof(*ireq));
537*f1f52e75SDan Williams 
538*f1f52e75SDan Williams 	return ireq->request_daddr + (requested_addr - base_addr);
539*f1f52e75SDan Williams }
540*f1f52e75SDan Williams 
541*f1f52e75SDan Williams /**
5426f231ddaSDan Williams  * This function gets the status of the request object.
5436f231ddaSDan Williams  * @request: This parameter points to the isci_request object
5446f231ddaSDan Williams  *
5456f231ddaSDan Williams  * status of the object as a isci_request_status enum.
5466f231ddaSDan Williams  */
5476f231ddaSDan Williams static inline
5486f231ddaSDan Williams enum isci_request_status isci_request_get_state(
5496f231ddaSDan Williams 	struct isci_request *isci_request)
5506f231ddaSDan Williams {
5516f231ddaSDan Williams 	BUG_ON(isci_request == NULL);
5526f231ddaSDan Williams 
5536f231ddaSDan Williams 	/*probably a bad sign...	*/
5546f231ddaSDan Williams 	if (isci_request->status == unallocated)
5556f231ddaSDan Williams 		dev_warn(&isci_request->isci_host->pdev->dev,
5566f231ddaSDan Williams 			 "%s: isci_request->status == unallocated\n",
5576f231ddaSDan Williams 			 __func__);
5586f231ddaSDan Williams 
5596f231ddaSDan Williams 	return isci_request->status;
5606f231ddaSDan Williams }
5616f231ddaSDan Williams 
5626f231ddaSDan Williams 
5636f231ddaSDan Williams /**
5646f231ddaSDan Williams  * isci_request_change_state() - This function sets the status of the request
5656f231ddaSDan Williams  *    object.
5666f231ddaSDan Williams  * @request: This parameter points to the isci_request object
5676f231ddaSDan Williams  * @status: This Parameter is the new status of the object
5686f231ddaSDan Williams  *
5696f231ddaSDan Williams  */
5706f231ddaSDan Williams static inline enum isci_request_status isci_request_change_state(
5716f231ddaSDan Williams 	struct isci_request *isci_request,
5726f231ddaSDan Williams 	enum isci_request_status status)
5736f231ddaSDan Williams {
5746f231ddaSDan Williams 	enum isci_request_status old_state;
5756f231ddaSDan Williams 	unsigned long flags;
5766f231ddaSDan Williams 
5776f231ddaSDan Williams 	dev_dbg(&isci_request->isci_host->pdev->dev,
5786f231ddaSDan Williams 		"%s: isci_request = %p, state = 0x%x\n",
5796f231ddaSDan Williams 		__func__,
5806f231ddaSDan Williams 		isci_request,
5816f231ddaSDan Williams 		status);
5826f231ddaSDan Williams 
5836f231ddaSDan Williams 	BUG_ON(isci_request == NULL);
5846f231ddaSDan Williams 
5856f231ddaSDan Williams 	spin_lock_irqsave(&isci_request->state_lock, flags);
5866f231ddaSDan Williams 	old_state = isci_request->status;
5876f231ddaSDan Williams 	isci_request->status = status;
5886f231ddaSDan Williams 	spin_unlock_irqrestore(&isci_request->state_lock, flags);
5896f231ddaSDan Williams 
5906f231ddaSDan Williams 	return old_state;
5916f231ddaSDan Williams }
5926f231ddaSDan Williams 
5936f231ddaSDan Williams /**
5946f231ddaSDan Williams  * isci_request_change_started_to_newstate() - This function sets the status of
5956f231ddaSDan Williams  *    the request object.
5966f231ddaSDan Williams  * @request: This parameter points to the isci_request object
5976f231ddaSDan Williams  * @status: This Parameter is the new status of the object
5986f231ddaSDan Williams  *
5996f231ddaSDan Williams  * state previous to any change.
6006f231ddaSDan Williams  */
6016f231ddaSDan Williams static inline enum isci_request_status isci_request_change_started_to_newstate(
6026f231ddaSDan Williams 	struct isci_request *isci_request,
6036f231ddaSDan Williams 	struct completion *completion_ptr,
6046f231ddaSDan Williams 	enum isci_request_status newstate)
6056f231ddaSDan Williams {
6066f231ddaSDan Williams 	enum isci_request_status old_state;
6076f231ddaSDan Williams 	unsigned long flags;
6086f231ddaSDan Williams 
6096f231ddaSDan Williams 	spin_lock_irqsave(&isci_request->state_lock, flags);
6106f231ddaSDan Williams 
6116f231ddaSDan Williams 	old_state = isci_request->status;
6126f231ddaSDan Williams 
613f219f010SJeff Skirvin 	if (old_state == started || old_state == aborting) {
6146f231ddaSDan Williams 		BUG_ON(isci_request->io_request_completion != NULL);
6156f231ddaSDan Williams 
6166f231ddaSDan Williams 		isci_request->io_request_completion = completion_ptr;
6176f231ddaSDan Williams 		isci_request->status = newstate;
6186f231ddaSDan Williams 	}
6196f231ddaSDan Williams 	spin_unlock_irqrestore(&isci_request->state_lock, flags);
6206f231ddaSDan Williams 
6216f231ddaSDan Williams 	dev_dbg(&isci_request->isci_host->pdev->dev,
6226f231ddaSDan Williams 		"%s: isci_request = %p, old_state = 0x%x\n",
6236f231ddaSDan Williams 		__func__,
6246f231ddaSDan Williams 		isci_request,
6256f231ddaSDan Williams 		old_state);
6266f231ddaSDan Williams 
6276f231ddaSDan Williams 	return old_state;
6286f231ddaSDan Williams }
6296f231ddaSDan Williams 
6306f231ddaSDan Williams /**
6316f231ddaSDan Williams  * isci_request_change_started_to_aborted() - This function sets the status of
6326f231ddaSDan Williams  *    the request object.
6336f231ddaSDan Williams  * @request: This parameter points to the isci_request object
6346f231ddaSDan Williams  * @completion_ptr: This parameter is saved as the kernel completion structure
6356f231ddaSDan Williams  *    signalled when the old request completes.
6366f231ddaSDan Williams  *
6376f231ddaSDan Williams  * state previous to any change.
6386f231ddaSDan Williams  */
6396f231ddaSDan Williams static inline enum isci_request_status isci_request_change_started_to_aborted(
6406f231ddaSDan Williams 	struct isci_request *isci_request,
6416f231ddaSDan Williams 	struct completion *completion_ptr)
6426f231ddaSDan Williams {
6436f231ddaSDan Williams 	return isci_request_change_started_to_newstate(
6446f231ddaSDan Williams 		       isci_request, completion_ptr, aborted
6456f231ddaSDan Williams 		       );
6466f231ddaSDan Williams }
6476f231ddaSDan Williams /**
6486f231ddaSDan Williams  * isci_request_free() - This function frees the request object.
6496f231ddaSDan Williams  * @isci_host: This parameter specifies the ISCI host object
6506f231ddaSDan Williams  * @isci_request: This parameter points to the isci_request object
6516f231ddaSDan Williams  *
6526f231ddaSDan Williams  */
6536f231ddaSDan Williams static inline void isci_request_free(
6546f231ddaSDan Williams 	struct isci_host *isci_host,
6556f231ddaSDan Williams 	struct isci_request *isci_request)
6566f231ddaSDan Williams {
6576cb4d6b3SBartosz Barcinski 	if (!isci_request)
6586cb4d6b3SBartosz Barcinski 		return;
6596f231ddaSDan Williams 
6606f231ddaSDan Williams 	/* release the dma memory if we fail. */
6616f231ddaSDan Williams 	dma_pool_free(isci_host->dma_pool, isci_request,
6626f231ddaSDan Williams 		      isci_request->request_daddr);
6636f231ddaSDan Williams }
6646f231ddaSDan Williams 
6656f231ddaSDan Williams 
6666f231ddaSDan Williams /* #define ISCI_REQUEST_VALIDATE_ACCESS
6676f231ddaSDan Williams  */
6686f231ddaSDan Williams 
6696f231ddaSDan Williams #ifdef ISCI_REQUEST_VALIDATE_ACCESS
6706f231ddaSDan Williams 
6716f231ddaSDan Williams static inline
6726f231ddaSDan Williams struct sas_task *isci_request_access_task(struct isci_request *isci_request)
6736f231ddaSDan Williams {
6746f231ddaSDan Williams 	BUG_ON(isci_request->ttype != io_task);
6756f231ddaSDan Williams 	return isci_request->ttype_ptr.io_task_ptr;
6766f231ddaSDan Williams }
6776f231ddaSDan Williams 
6786f231ddaSDan Williams static inline
6796f231ddaSDan Williams struct isci_tmf *isci_request_access_tmf(struct isci_request *isci_request)
6806f231ddaSDan Williams {
6816f231ddaSDan Williams 	BUG_ON(isci_request->ttype != tmf_task);
6826f231ddaSDan Williams 	return isci_request->ttype_ptr.tmf_task_ptr;
6836f231ddaSDan Williams }
6846f231ddaSDan Williams 
6856f231ddaSDan Williams #else  /* not ISCI_REQUEST_VALIDATE_ACCESS */
6866f231ddaSDan Williams 
6876f231ddaSDan Williams #define isci_request_access_task(RequestPtr) \
6886f231ddaSDan Williams 	((RequestPtr)->ttype_ptr.io_task_ptr)
6896f231ddaSDan Williams 
6906f231ddaSDan Williams #define isci_request_access_tmf(RequestPtr)  \
6916f231ddaSDan Williams 	((RequestPtr)->ttype_ptr.tmf_task_ptr)
6926f231ddaSDan Williams 
6936f231ddaSDan Williams #endif /* not ISCI_REQUEST_VALIDATE_ACCESS */
6946f231ddaSDan Williams 
6956f231ddaSDan Williams 
6966f231ddaSDan Williams int isci_request_alloc_tmf(
6976f231ddaSDan Williams 	struct isci_host *isci_host,
6986f231ddaSDan Williams 	struct isci_tmf *isci_tmf,
6996f231ddaSDan Williams 	struct isci_request **isci_request,
7006f231ddaSDan Williams 	struct isci_remote_device *isci_device,
7016f231ddaSDan Williams 	gfp_t gfp_flags);
7026f231ddaSDan Williams 
7036f231ddaSDan Williams 
7046f231ddaSDan Williams int isci_request_execute(
7056f231ddaSDan Williams 	struct isci_host *isci_host,
7066f231ddaSDan Williams 	struct sas_task *task,
7076f231ddaSDan Williams 	struct isci_request **request,
7086f231ddaSDan Williams 	gfp_t gfp_flags);
7096f231ddaSDan Williams 
7106f231ddaSDan Williams /**
7116f231ddaSDan Williams  * isci_request_unmap_sgl() - This function unmaps the DMA address of a given
7126f231ddaSDan Williams  *    sgl
7136f231ddaSDan Williams  * @request: This parameter points to the isci_request object
7146f231ddaSDan Williams  * @*pdev: This Parameter is the pci_device struct for the controller
7156f231ddaSDan Williams  *
7166f231ddaSDan Williams  */
7176f231ddaSDan Williams static inline void isci_request_unmap_sgl(
7186f231ddaSDan Williams 	struct isci_request *request,
7196f231ddaSDan Williams 	struct pci_dev *pdev)
7206f231ddaSDan Williams {
7216f231ddaSDan Williams 	struct sas_task *task = isci_request_access_task(request);
7226f231ddaSDan Williams 
7236f231ddaSDan Williams 	dev_dbg(&request->isci_host->pdev->dev,
7246f231ddaSDan Williams 		"%s: request = %p, task = %p,\n"
7256f231ddaSDan Williams 		"task->data_dir = %d, is_sata = %d\n ",
7266f231ddaSDan Williams 		__func__,
7276f231ddaSDan Williams 		request,
7286f231ddaSDan Williams 		task,
7296f231ddaSDan Williams 		task->data_dir,
7306f231ddaSDan Williams 		sas_protocol_ata(task->task_proto));
7316f231ddaSDan Williams 
7326f231ddaSDan Williams 	if ((task->data_dir != PCI_DMA_NONE) &&
7336f231ddaSDan Williams 	    !sas_protocol_ata(task->task_proto)) {
7346f231ddaSDan Williams 		if (task->num_scatter == 0)
7356f231ddaSDan Williams 			/* 0 indicates a single dma address */
7366f231ddaSDan Williams 			dma_unmap_single(
7376f231ddaSDan Williams 				&pdev->dev,
7386f231ddaSDan Williams 				request->zero_scatter_daddr,
7396f231ddaSDan Williams 				task->total_xfer_len,
7406f231ddaSDan Williams 				task->data_dir
7416f231ddaSDan Williams 				);
7426f231ddaSDan Williams 
7436f231ddaSDan Williams 		else  /* unmap the sgl dma addresses */
7446f231ddaSDan Williams 			dma_unmap_sg(
7456f231ddaSDan Williams 				&pdev->dev,
7466f231ddaSDan Williams 				task->scatter,
7476f231ddaSDan Williams 				request->num_sg_entries,
7486f231ddaSDan Williams 				task->data_dir
7496f231ddaSDan Williams 				);
7506f231ddaSDan Williams 	}
7516f231ddaSDan Williams }
7526f231ddaSDan Williams 
7536f231ddaSDan Williams /**
7546f231ddaSDan Williams  * isci_request_io_request_get_next_sge() - This function is called by the sci
7556f231ddaSDan Williams  *    core to retrieve the next sge for a given request.
7566f231ddaSDan Williams  * @request: This parameter is the isci_request object.
7576f231ddaSDan Williams  * @current_sge_address: This parameter is the last sge retrieved by the sci
7586f231ddaSDan Williams  *    core for this request.
7596f231ddaSDan Williams  *
7606f231ddaSDan Williams  * pointer to the next sge for specified request.
7616f231ddaSDan Williams  */
7626f231ddaSDan Williams static inline void *isci_request_io_request_get_next_sge(
7636f231ddaSDan Williams 	struct isci_request *request,
7646f231ddaSDan Williams 	void *current_sge_address)
7656f231ddaSDan Williams {
7666f231ddaSDan Williams 	struct sas_task *task = isci_request_access_task(request);
7676f231ddaSDan Williams 	void *ret = NULL;
7686f231ddaSDan Williams 
7696f231ddaSDan Williams 	dev_dbg(&request->isci_host->pdev->dev,
7706f231ddaSDan Williams 		"%s: request = %p, "
7716f231ddaSDan Williams 		"current_sge_address = %p, "
7726f231ddaSDan Williams 		"num_scatter = %d\n",
7736f231ddaSDan Williams 		__func__,
7746f231ddaSDan Williams 		request,
7756f231ddaSDan Williams 		current_sge_address,
7766f231ddaSDan Williams 		task->num_scatter);
7776f231ddaSDan Williams 
7786f231ddaSDan Williams 	if (!current_sge_address)	/* First time through.. */
7796f231ddaSDan Williams 		ret = task->scatter;    /* always task->scatter */
7806f231ddaSDan Williams 	else if (task->num_scatter == 0) /* Next element, if num_scatter == 0 */
7816f231ddaSDan Williams 		ret = NULL;              /* there is only one element. */
7826f231ddaSDan Williams 	else
7836f231ddaSDan Williams 		ret = sg_next(current_sge_address);     /* sg_next returns NULL
7846f231ddaSDan Williams 							 * for the last element
7856f231ddaSDan Williams 							 */
7866f231ddaSDan Williams 
7876f231ddaSDan Williams 	dev_dbg(&request->isci_host->pdev->dev,
7886f231ddaSDan Williams 		"%s: next sge address = %p\n",
7896f231ddaSDan Williams 		__func__,
7906f231ddaSDan Williams 		ret);
7916f231ddaSDan Williams 
7926f231ddaSDan Williams 	return ret;
7936f231ddaSDan Williams }
7946f231ddaSDan Williams 
795*f1f52e75SDan Williams void isci_terminate_pending_requests(struct isci_host *isci_host,
7966f231ddaSDan Williams 				     struct isci_remote_device *isci_device,
7976f231ddaSDan Williams 				     enum isci_request_status new_request_state);
798*f1f52e75SDan Williams enum sci_status scic_task_request_construct(struct scic_sds_controller *scic,
799*f1f52e75SDan Williams 					    struct scic_sds_remote_device *sci_dev,
800*f1f52e75SDan Williams 					    u16 io_tag,
801*f1f52e75SDan Williams 					    struct scic_sds_request *sci_req);
802*f1f52e75SDan Williams enum sci_status scic_task_request_construct_ssp(struct scic_sds_request *sci_req);
803*f1f52e75SDan Williams enum sci_status scic_task_request_construct_sata(struct scic_sds_request *sci_req);
804*f1f52e75SDan Williams enum sci_status scic_io_request_construct_smp(struct scic_sds_request *sci_req);
805*f1f52e75SDan Williams void scic_stp_io_request_set_ncq_tag(struct scic_sds_request *sci_req, u16 ncq_tag);
806*f1f52e75SDan Williams void scic_sds_smp_request_copy_response(struct scic_sds_request *sci_req);
8076f231ddaSDan Williams #endif /* !defined(_ISCI_REQUEST_H_) */
808