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" 61f1f52e75SDan Williams #include "scu_task_context.h" 62f1f52e75SDan 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 86f1f52e75SDan Williams enum sci_request_protocol { 87f1f52e75SDan Williams SCIC_NO_PROTOCOL, 88f1f52e75SDan Williams SCIC_SMP_PROTOCOL, 89f1f52e75SDan Williams SCIC_SSP_PROTOCOL, 90f1f52e75SDan Williams SCIC_STP_PROTOCOL 91f1f52e75SDan Williams }; /* XXX remove me, use sas_task.dev instead */; 92f1f52e75SDan Williams 93f1f52e75SDan Williams struct scic_sds_request { 94f1f52e75SDan Williams /** 95f1f52e75SDan Williams * This field contains the information for the base request state machine. 96f1f52e75SDan Williams */ 97f1f52e75SDan Williams struct sci_base_state_machine state_machine; 98f1f52e75SDan Williams 99f1f52e75SDan Williams /** 100f1f52e75SDan Williams * This field simply points to the controller to which this IO request 101f1f52e75SDan Williams * is associated. 102f1f52e75SDan Williams */ 103f1f52e75SDan Williams struct scic_sds_controller *owning_controller; 104f1f52e75SDan Williams 105f1f52e75SDan Williams /** 106f1f52e75SDan Williams * This field simply points to the remote device to which this IO request 107f1f52e75SDan Williams * is associated. 108f1f52e75SDan Williams */ 109f1f52e75SDan Williams struct scic_sds_remote_device *target_device; 110f1f52e75SDan Williams 111f1f52e75SDan Williams /** 112f1f52e75SDan Williams * This field is utilized to determine if the SCI user is managing 113f1f52e75SDan Williams * the IO tag for this request or if the core is managing it. 114f1f52e75SDan Williams */ 115f1f52e75SDan Williams bool was_tag_assigned_by_user; 116f1f52e75SDan Williams 117f1f52e75SDan Williams /** 118f1f52e75SDan Williams * This field indicates the IO tag for this request. The IO tag is 119f1f52e75SDan Williams * comprised of the task_index and a sequence count. The sequence count 120f1f52e75SDan Williams * is utilized to help identify tasks from one life to another. 121f1f52e75SDan Williams */ 122f1f52e75SDan Williams u16 io_tag; 123f1f52e75SDan Williams 124f1f52e75SDan Williams /** 125f1f52e75SDan Williams * This field specifies the protocol being utilized for this 126f1f52e75SDan Williams * IO request. 127f1f52e75SDan Williams */ 128f1f52e75SDan Williams enum sci_request_protocol protocol; 129f1f52e75SDan Williams 130f1f52e75SDan Williams /** 131f1f52e75SDan Williams * This field indicates the completion status taken from the SCUs 132f1f52e75SDan Williams * completion code. It indicates the completion result for the SCU hardware. 133f1f52e75SDan Williams */ 134f1f52e75SDan Williams u32 scu_status; 135f1f52e75SDan Williams 136f1f52e75SDan Williams /** 137f1f52e75SDan Williams * This field indicates the completion status returned to the SCI user. It 138f1f52e75SDan Williams * indicates the users view of the io request completion. 139f1f52e75SDan Williams */ 140f1f52e75SDan Williams u32 sci_status; 141f1f52e75SDan Williams 142f1f52e75SDan Williams /** 143f1f52e75SDan Williams * This field contains the value to be utilized when posting (e.g. Post_TC, 144f1f52e75SDan Williams * Post_TC_Abort) this request to the silicon. 145f1f52e75SDan Williams */ 146f1f52e75SDan Williams u32 post_context; 147f1f52e75SDan Williams 148f1f52e75SDan Williams struct scu_task_context *task_context_buffer; 149f1f52e75SDan Williams struct scu_task_context tc ____cacheline_aligned; 150f1f52e75SDan Williams 151f1f52e75SDan Williams /* could be larger with sg chaining */ 152f1f52e75SDan Williams #define SCU_SGL_SIZE ((SCU_IO_REQUEST_SGE_COUNT + 1) / 2) 153f1f52e75SDan Williams struct scu_sgl_element_pair sg_table[SCU_SGL_SIZE] __attribute__ ((aligned(32))); 154f1f52e75SDan Williams 155f1f52e75SDan Williams /** 156f1f52e75SDan Williams * This field indicates if this request is a task management request or 157f1f52e75SDan Williams * normal IO request. 158f1f52e75SDan Williams */ 159f1f52e75SDan Williams bool is_task_management_request; 160f1f52e75SDan Williams 161f1f52e75SDan Williams /** 162f1f52e75SDan Williams * This field indicates that this request contains an initialized started 163f1f52e75SDan Williams * substate machine. 164f1f52e75SDan Williams */ 165f1f52e75SDan Williams bool has_started_substate_machine; 166f1f52e75SDan Williams 167f1f52e75SDan Williams /** 168f1f52e75SDan Williams * This field is a pointer to the stored rx frame data. It is used in STP 169f1f52e75SDan Williams * internal requests and SMP response frames. If this field is non-NULL the 170f1f52e75SDan Williams * saved frame must be released on IO request completion. 171f1f52e75SDan Williams * 172f1f52e75SDan Williams * @todo In the future do we want to keep a list of RX frame buffers? 173f1f52e75SDan Williams */ 174f1f52e75SDan Williams u32 saved_rx_frame_index; 175f1f52e75SDan Williams 176f1f52e75SDan Williams /** 177f1f52e75SDan Williams * This field specifies the data necessary to manage the sub-state 178f1f52e75SDan Williams * machine executed while in the SCI_BASE_REQUEST_STATE_STARTED state. 179f1f52e75SDan Williams */ 180f1f52e75SDan Williams struct sci_base_state_machine started_substate_machine; 181f1f52e75SDan Williams 182f1f52e75SDan Williams /** 183f1f52e75SDan Williams * This field specifies the current state handlers in place for this 184f1f52e75SDan Williams * IO Request object. This field is updated each time the request 185f1f52e75SDan Williams * changes state. 186f1f52e75SDan Williams */ 187f1f52e75SDan Williams const struct scic_sds_io_request_state_handler *state_handlers; 188f1f52e75SDan Williams 189f1f52e75SDan Williams /** 190f1f52e75SDan Williams * This field in the recorded device sequence for the io request. This is 191f1f52e75SDan Williams * recorded during the build operation and is compared in the start 192f1f52e75SDan Williams * operation. If the sequence is different then there was a change of 193f1f52e75SDan Williams * devices from the build to start operations. 194f1f52e75SDan Williams */ 195f1f52e75SDan Williams u8 device_sequence; 196f1f52e75SDan Williams 197f1f52e75SDan Williams union { 198f1f52e75SDan Williams struct { 199f1f52e75SDan Williams union { 200f1f52e75SDan Williams struct ssp_cmd_iu cmd; 201f1f52e75SDan Williams struct ssp_task_iu tmf; 202f1f52e75SDan Williams }; 203f1f52e75SDan Williams union { 204f1f52e75SDan Williams struct ssp_response_iu rsp; 205f1f52e75SDan Williams u8 rsp_buf[SSP_RESP_IU_MAX_SIZE]; 206f1f52e75SDan Williams }; 207f1f52e75SDan Williams } ssp; 208f1f52e75SDan Williams 209f1f52e75SDan Williams struct { 210f1f52e75SDan Williams struct smp_req cmd; 211f1f52e75SDan Williams struct smp_resp rsp; 212f1f52e75SDan Williams } smp; 213f1f52e75SDan Williams 214f1f52e75SDan Williams struct { 215f1f52e75SDan Williams struct scic_sds_stp_request req; 216f1f52e75SDan Williams struct host_to_dev_fis cmd; 217f1f52e75SDan Williams struct dev_to_host_fis rsp; 218f1f52e75SDan Williams } stp; 219f1f52e75SDan Williams }; 220f1f52e75SDan Williams 221f1f52e75SDan Williams }; 222f1f52e75SDan Williams 223f1f52e75SDan Williams static inline struct scic_sds_request *to_sci_req(struct scic_sds_stp_request *stp_req) 224f1f52e75SDan Williams { 225f1f52e75SDan Williams struct scic_sds_request *sci_req; 226f1f52e75SDan Williams 227f1f52e75SDan Williams sci_req = container_of(stp_req, typeof(*sci_req), stp.req); 228f1f52e75SDan Williams return sci_req; 229f1f52e75SDan Williams } 230f1f52e75SDan 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 /** 275f1f52e75SDan Williams * enum sci_base_request_states - This enumeration depicts all the states for 276f1f52e75SDan Williams * the common request state machine. 277f1f52e75SDan Williams * 278f1f52e75SDan Williams * 279f1f52e75SDan Williams */ 280f1f52e75SDan Williams enum sci_base_request_states { 281f1f52e75SDan Williams /** 282f1f52e75SDan Williams * Simply the initial state for the base request state machine. 283f1f52e75SDan Williams */ 284f1f52e75SDan Williams SCI_BASE_REQUEST_STATE_INITIAL, 285f1f52e75SDan Williams 286f1f52e75SDan Williams /** 287f1f52e75SDan Williams * This state indicates that the request has been constructed. This state 288f1f52e75SDan Williams * is entered from the INITIAL state. 289f1f52e75SDan Williams */ 290f1f52e75SDan Williams SCI_BASE_REQUEST_STATE_CONSTRUCTED, 291f1f52e75SDan Williams 292f1f52e75SDan Williams /** 293f1f52e75SDan Williams * This state indicates that the request has been started. This state is 294f1f52e75SDan Williams * entered from the CONSTRUCTED state. 295f1f52e75SDan Williams */ 296f1f52e75SDan Williams SCI_BASE_REQUEST_STATE_STARTED, 297f1f52e75SDan Williams 298f1f52e75SDan Williams /** 299*f139303dSDan Williams * The AWAIT_TC_COMPLETION sub-state indicates that the started raw 300*f139303dSDan Williams * task management request is waiting for the transmission of the 301*f139303dSDan Williams * initial frame (i.e. command, task, etc.). 302*f139303dSDan Williams */ 303*f139303dSDan Williams SCIC_SDS_IO_REQUEST_STARTED_TASK_MGMT_SUBSTATE_AWAIT_TC_COMPLETION, 304*f139303dSDan Williams 305*f139303dSDan Williams /** 306*f139303dSDan Williams * This sub-state indicates that the started task management request 307*f139303dSDan Williams * is waiting for the reception of an unsolicited frame 308*f139303dSDan Williams * (i.e. response IU). 309*f139303dSDan Williams */ 310*f139303dSDan Williams SCIC_SDS_IO_REQUEST_STARTED_TASK_MGMT_SUBSTATE_AWAIT_TC_RESPONSE, 311*f139303dSDan Williams 312*f139303dSDan Williams /** 313f1f52e75SDan Williams * This state indicates that the request has completed. 314f1f52e75SDan Williams * This state is entered from the STARTED state. This state is entered from 315f1f52e75SDan Williams * the ABORTING state. 316f1f52e75SDan Williams */ 317f1f52e75SDan Williams SCI_BASE_REQUEST_STATE_COMPLETED, 318f1f52e75SDan Williams 319f1f52e75SDan Williams /** 320f1f52e75SDan Williams * This state indicates that the request is in the process of being 321f1f52e75SDan Williams * terminated/aborted. 322f1f52e75SDan Williams * This state is entered from the CONSTRUCTED state. 323f1f52e75SDan Williams * This state is entered from the STARTED state. 324f1f52e75SDan Williams */ 325f1f52e75SDan Williams SCI_BASE_REQUEST_STATE_ABORTING, 326f1f52e75SDan Williams 327f1f52e75SDan Williams /** 328f1f52e75SDan Williams * Simply the final state for the base request state machine. 329f1f52e75SDan Williams */ 330f1f52e75SDan Williams SCI_BASE_REQUEST_STATE_FINAL, 331f1f52e75SDan Williams }; 332f1f52e75SDan Williams 333f1f52e75SDan Williams typedef enum sci_status (*scic_sds_io_request_handler_t) 334f1f52e75SDan Williams (struct scic_sds_request *request); 335f1f52e75SDan Williams typedef enum sci_status (*scic_sds_io_request_frame_handler_t) 336f1f52e75SDan Williams (struct scic_sds_request *req, u32 frame); 337f1f52e75SDan Williams typedef enum sci_status (*scic_sds_io_request_event_handler_t) 338f1f52e75SDan Williams (struct scic_sds_request *req, u32 event); 339f1f52e75SDan Williams typedef enum sci_status (*scic_sds_io_request_task_completion_handler_t) 340f1f52e75SDan Williams (struct scic_sds_request *req, u32 completion_code); 341f1f52e75SDan Williams 342f1f52e75SDan Williams /** 343f1f52e75SDan Williams * struct scic_sds_io_request_state_handler - This is the SDS core definition 344f1f52e75SDan Williams * of the state handlers. 345f1f52e75SDan Williams * 346f1f52e75SDan Williams * 347f1f52e75SDan Williams */ 348f1f52e75SDan Williams struct scic_sds_io_request_state_handler { 349f1f52e75SDan Williams /** 350f1f52e75SDan Williams * The start_handler specifies the method invoked when a user attempts to 351f1f52e75SDan Williams * start a request. 352f1f52e75SDan Williams */ 353f1f52e75SDan Williams scic_sds_io_request_handler_t start_handler; 354f1f52e75SDan Williams 355f1f52e75SDan Williams /** 356f1f52e75SDan Williams * The abort_handler specifies the method invoked when a user attempts to 357f1f52e75SDan Williams * abort a request. 358f1f52e75SDan Williams */ 359f1f52e75SDan Williams scic_sds_io_request_handler_t abort_handler; 360f1f52e75SDan Williams 361f1f52e75SDan Williams /** 362f1f52e75SDan Williams * The complete_handler specifies the method invoked when a user attempts to 363f1f52e75SDan Williams * complete a request. 364f1f52e75SDan Williams */ 365f1f52e75SDan Williams scic_sds_io_request_handler_t complete_handler; 366f1f52e75SDan Williams 367f1f52e75SDan Williams scic_sds_io_request_task_completion_handler_t tc_completion_handler; 368f1f52e75SDan Williams scic_sds_io_request_event_handler_t event_handler; 369f1f52e75SDan Williams scic_sds_io_request_frame_handler_t frame_handler; 370f1f52e75SDan Williams 371f1f52e75SDan Williams }; 372f1f52e75SDan Williams 373f1f52e75SDan Williams extern const struct sci_base_state scic_sds_io_request_started_task_mgmt_substate_table[]; 374f1f52e75SDan Williams 375f1f52e75SDan Williams /** 376f1f52e75SDan Williams * scic_sds_request_get_controller() - 377f1f52e75SDan Williams * 378f1f52e75SDan Williams * This macro will return the controller for this io request object 379f1f52e75SDan Williams */ 380f1f52e75SDan Williams #define scic_sds_request_get_controller(sci_req) \ 381f1f52e75SDan Williams ((sci_req)->owning_controller) 382f1f52e75SDan Williams 383f1f52e75SDan Williams /** 384f1f52e75SDan Williams * scic_sds_request_get_device() - 385f1f52e75SDan Williams * 386f1f52e75SDan Williams * This macro will return the device for this io request object 387f1f52e75SDan Williams */ 388f1f52e75SDan Williams #define scic_sds_request_get_device(sci_req) \ 389f1f52e75SDan Williams ((sci_req)->target_device) 390f1f52e75SDan Williams 391f1f52e75SDan Williams /** 392f1f52e75SDan Williams * scic_sds_request_get_port() - 393f1f52e75SDan Williams * 394f1f52e75SDan Williams * This macro will return the port for this io request object 395f1f52e75SDan Williams */ 396f1f52e75SDan Williams #define scic_sds_request_get_port(sci_req) \ 397f1f52e75SDan Williams scic_sds_remote_device_get_port(scic_sds_request_get_device(sci_req)) 398f1f52e75SDan Williams 399f1f52e75SDan Williams /** 400f1f52e75SDan Williams * scic_sds_request_get_post_context() - 401f1f52e75SDan Williams * 402f1f52e75SDan Williams * This macro returns the constructed post context result for the io request. 403f1f52e75SDan Williams */ 404f1f52e75SDan Williams #define scic_sds_request_get_post_context(sci_req) \ 405f1f52e75SDan Williams ((sci_req)->post_context) 406f1f52e75SDan Williams 407f1f52e75SDan Williams /** 408f1f52e75SDan Williams * scic_sds_request_get_task_context() - 409f1f52e75SDan Williams * 410f1f52e75SDan Williams * This is a helper macro to return the os handle for this request object. 411f1f52e75SDan Williams */ 412f1f52e75SDan Williams #define scic_sds_request_get_task_context(request) \ 413f1f52e75SDan Williams ((request)->task_context_buffer) 414f1f52e75SDan Williams 415f1f52e75SDan Williams /** 416f1f52e75SDan Williams * scic_sds_request_set_status() - 417f1f52e75SDan Williams * 418f1f52e75SDan Williams * This macro will set the scu hardware status and sci request completion 419f1f52e75SDan Williams * status for an io request. 420f1f52e75SDan Williams */ 421f1f52e75SDan Williams #define scic_sds_request_set_status(request, scu_status_code, sci_status_code) \ 422f1f52e75SDan Williams { \ 423f1f52e75SDan Williams (request)->scu_status = (scu_status_code); \ 424f1f52e75SDan Williams (request)->sci_status = (sci_status_code); \ 425f1f52e75SDan Williams } 426f1f52e75SDan Williams 427f1f52e75SDan Williams #define scic_sds_request_complete(a_request) \ 428f1f52e75SDan Williams ((a_request)->state_handlers->complete_handler(a_request)) 429f1f52e75SDan Williams 430f1f52e75SDan Williams 431f1f52e75SDan Williams extern enum sci_status 432f1f52e75SDan Williams scic_sds_io_request_tc_completion(struct scic_sds_request *request, u32 completion_code); 433f1f52e75SDan Williams 434f1f52e75SDan Williams /** 435f1f52e75SDan Williams * SCU_SGL_ZERO() - 436f1f52e75SDan Williams * 437f1f52e75SDan Williams * This macro zeros the hardware SGL element data 438f1f52e75SDan Williams */ 439f1f52e75SDan Williams #define SCU_SGL_ZERO(scu_sge) \ 440f1f52e75SDan Williams { \ 441f1f52e75SDan Williams (scu_sge).length = 0; \ 442f1f52e75SDan Williams (scu_sge).address_lower = 0; \ 443f1f52e75SDan Williams (scu_sge).address_upper = 0; \ 444f1f52e75SDan Williams (scu_sge).address_modifier = 0; \ 445f1f52e75SDan Williams } 446f1f52e75SDan Williams 447f1f52e75SDan Williams /** 448f1f52e75SDan Williams * SCU_SGL_COPY() - 449f1f52e75SDan Williams * 450f1f52e75SDan Williams * This macro copys the SGL Element data from the host os to the hardware SGL 451f1f52e75SDan Williams * elment data 452f1f52e75SDan Williams */ 453f1f52e75SDan Williams #define SCU_SGL_COPY(scu_sge, os_sge) \ 454f1f52e75SDan Williams { \ 455f1f52e75SDan Williams (scu_sge).length = sg_dma_len(sg); \ 456f1f52e75SDan Williams (scu_sge).address_upper = \ 457f1f52e75SDan Williams upper_32_bits(sg_dma_address(sg)); \ 458f1f52e75SDan Williams (scu_sge).address_lower = \ 459f1f52e75SDan Williams lower_32_bits(sg_dma_address(sg)); \ 460f1f52e75SDan Williams (scu_sge).address_modifier = 0; \ 461f1f52e75SDan Williams } 462f1f52e75SDan Williams 463f1f52e75SDan Williams void scic_sds_request_build_sgl(struct scic_sds_request *sci_req); 464f1f52e75SDan Williams void scic_sds_stp_request_assign_buffers(struct scic_sds_request *sci_req); 465f1f52e75SDan Williams void scic_sds_smp_request_assign_buffers(struct scic_sds_request *sci_req); 466f1f52e75SDan Williams enum sci_status scic_sds_request_start(struct scic_sds_request *sci_req); 467f1f52e75SDan Williams enum sci_status scic_sds_io_request_terminate(struct scic_sds_request *sci_req); 468f1f52e75SDan Williams enum sci_status scic_sds_io_request_event_handler(struct scic_sds_request *sci_req, 469f1f52e75SDan Williams u32 event_code); 470f1f52e75SDan Williams enum sci_status scic_sds_io_request_frame_handler(struct scic_sds_request *sci_req, 471f1f52e75SDan Williams u32 frame_index); 472f1f52e75SDan Williams enum sci_status scic_sds_task_request_terminate(struct scic_sds_request *sci_req); 473f1f52e75SDan Williams enum sci_status scic_sds_request_started_state_abort_handler(struct scic_sds_request *sci_req); 474f1f52e75SDan Williams 475f1f52e75SDan Williams 476f1f52e75SDan Williams /** 477f1f52e75SDan Williams * enum _scic_sds_smp_request_started_substates - This enumeration depicts all 478f1f52e75SDan Williams * of the substates for a SMP request to be performed in the STARTED 479f1f52e75SDan Williams * super-state. 480f1f52e75SDan Williams * 481f1f52e75SDan Williams * 482f1f52e75SDan Williams */ 483f1f52e75SDan Williams enum scic_sds_smp_request_started_substates { 484f1f52e75SDan Williams /** 485f1f52e75SDan Williams * This sub-state indicates that the started task management request 486f1f52e75SDan Williams * is waiting for the reception of an unsolicited frame 487f1f52e75SDan Williams * (i.e. response IU). 488f1f52e75SDan Williams */ 489f1f52e75SDan Williams SCIC_SDS_SMP_REQUEST_STARTED_SUBSTATE_AWAIT_RESPONSE, 490f1f52e75SDan Williams 491f1f52e75SDan Williams /** 492f1f52e75SDan Williams * The AWAIT_TC_COMPLETION sub-state indicates that the started SMP request is 493f1f52e75SDan Williams * waiting for the transmission of the initial frame (i.e. command, task, etc.). 494f1f52e75SDan Williams */ 495f1f52e75SDan Williams SCIC_SDS_SMP_REQUEST_STARTED_SUBSTATE_AWAIT_TC_COMPLETION, 496f1f52e75SDan Williams }; 497f1f52e75SDan Williams 498f1f52e75SDan Williams 499f1f52e75SDan Williams 500f1f52e75SDan Williams /* XXX open code in caller */ 501f1f52e75SDan Williams static inline void *scic_request_get_virt_addr(struct scic_sds_request *sci_req, 502f1f52e75SDan Williams dma_addr_t phys_addr) 503f1f52e75SDan Williams { 504f1f52e75SDan Williams struct isci_request *ireq = sci_req_to_ireq(sci_req); 505f1f52e75SDan Williams dma_addr_t offset; 506f1f52e75SDan Williams 507f1f52e75SDan Williams BUG_ON(phys_addr < ireq->request_daddr); 508f1f52e75SDan Williams 509f1f52e75SDan Williams offset = phys_addr - ireq->request_daddr; 510f1f52e75SDan Williams 511f1f52e75SDan Williams BUG_ON(offset >= sizeof(*ireq)); 512f1f52e75SDan Williams 513f1f52e75SDan Williams return (char *)ireq + offset; 514f1f52e75SDan Williams } 515f1f52e75SDan Williams 516f1f52e75SDan Williams /* XXX open code in caller */ 517f1f52e75SDan Williams static inline dma_addr_t scic_io_request_get_dma_addr(struct scic_sds_request *sci_req, 518f1f52e75SDan Williams void *virt_addr) 519f1f52e75SDan Williams { 520f1f52e75SDan Williams struct isci_request *ireq = sci_req_to_ireq(sci_req); 521f1f52e75SDan Williams 522f1f52e75SDan Williams char *requested_addr = (char *)virt_addr; 523f1f52e75SDan Williams char *base_addr = (char *)ireq; 524f1f52e75SDan Williams 525f1f52e75SDan Williams BUG_ON(requested_addr < base_addr); 526f1f52e75SDan Williams BUG_ON((requested_addr - base_addr) >= sizeof(*ireq)); 527f1f52e75SDan Williams 528f1f52e75SDan Williams return ireq->request_daddr + (requested_addr - base_addr); 529f1f52e75SDan Williams } 530f1f52e75SDan Williams 531f1f52e75SDan Williams /** 5326f231ddaSDan Williams * This function gets the status of the request object. 5336f231ddaSDan Williams * @request: This parameter points to the isci_request object 5346f231ddaSDan Williams * 5356f231ddaSDan Williams * status of the object as a isci_request_status enum. 5366f231ddaSDan Williams */ 5376f231ddaSDan Williams static inline 5386f231ddaSDan Williams enum isci_request_status isci_request_get_state( 5396f231ddaSDan Williams struct isci_request *isci_request) 5406f231ddaSDan Williams { 5416f231ddaSDan Williams BUG_ON(isci_request == NULL); 5426f231ddaSDan Williams 5436f231ddaSDan Williams /*probably a bad sign... */ 5446f231ddaSDan Williams if (isci_request->status == unallocated) 5456f231ddaSDan Williams dev_warn(&isci_request->isci_host->pdev->dev, 5466f231ddaSDan Williams "%s: isci_request->status == unallocated\n", 5476f231ddaSDan Williams __func__); 5486f231ddaSDan Williams 5496f231ddaSDan Williams return isci_request->status; 5506f231ddaSDan Williams } 5516f231ddaSDan Williams 5526f231ddaSDan Williams 5536f231ddaSDan Williams /** 5546f231ddaSDan Williams * isci_request_change_state() - This function sets the status of the request 5556f231ddaSDan Williams * object. 5566f231ddaSDan Williams * @request: This parameter points to the isci_request object 5576f231ddaSDan Williams * @status: This Parameter is the new status of the object 5586f231ddaSDan Williams * 5596f231ddaSDan Williams */ 5606f231ddaSDan Williams static inline enum isci_request_status isci_request_change_state( 5616f231ddaSDan Williams struct isci_request *isci_request, 5626f231ddaSDan Williams enum isci_request_status status) 5636f231ddaSDan Williams { 5646f231ddaSDan Williams enum isci_request_status old_state; 5656f231ddaSDan Williams unsigned long flags; 5666f231ddaSDan Williams 5676f231ddaSDan Williams dev_dbg(&isci_request->isci_host->pdev->dev, 5686f231ddaSDan Williams "%s: isci_request = %p, state = 0x%x\n", 5696f231ddaSDan Williams __func__, 5706f231ddaSDan Williams isci_request, 5716f231ddaSDan Williams status); 5726f231ddaSDan Williams 5736f231ddaSDan Williams BUG_ON(isci_request == NULL); 5746f231ddaSDan Williams 5756f231ddaSDan Williams spin_lock_irqsave(&isci_request->state_lock, flags); 5766f231ddaSDan Williams old_state = isci_request->status; 5776f231ddaSDan Williams isci_request->status = status; 5786f231ddaSDan Williams spin_unlock_irqrestore(&isci_request->state_lock, flags); 5796f231ddaSDan Williams 5806f231ddaSDan Williams return old_state; 5816f231ddaSDan Williams } 5826f231ddaSDan Williams 5836f231ddaSDan Williams /** 5846f231ddaSDan Williams * isci_request_change_started_to_newstate() - This function sets the status of 5856f231ddaSDan Williams * the request object. 5866f231ddaSDan Williams * @request: This parameter points to the isci_request object 5876f231ddaSDan Williams * @status: This Parameter is the new status of the object 5886f231ddaSDan Williams * 5896f231ddaSDan Williams * state previous to any change. 5906f231ddaSDan Williams */ 5916f231ddaSDan Williams static inline enum isci_request_status isci_request_change_started_to_newstate( 5926f231ddaSDan Williams struct isci_request *isci_request, 5936f231ddaSDan Williams struct completion *completion_ptr, 5946f231ddaSDan Williams enum isci_request_status newstate) 5956f231ddaSDan Williams { 5966f231ddaSDan Williams enum isci_request_status old_state; 5976f231ddaSDan Williams unsigned long flags; 5986f231ddaSDan Williams 5996f231ddaSDan Williams spin_lock_irqsave(&isci_request->state_lock, flags); 6006f231ddaSDan Williams 6016f231ddaSDan Williams old_state = isci_request->status; 6026f231ddaSDan Williams 603f219f010SJeff Skirvin if (old_state == started || old_state == aborting) { 6046f231ddaSDan Williams BUG_ON(isci_request->io_request_completion != NULL); 6056f231ddaSDan Williams 6066f231ddaSDan Williams isci_request->io_request_completion = completion_ptr; 6076f231ddaSDan Williams isci_request->status = newstate; 6086f231ddaSDan Williams } 6096f231ddaSDan Williams spin_unlock_irqrestore(&isci_request->state_lock, flags); 6106f231ddaSDan Williams 6116f231ddaSDan Williams dev_dbg(&isci_request->isci_host->pdev->dev, 6126f231ddaSDan Williams "%s: isci_request = %p, old_state = 0x%x\n", 6136f231ddaSDan Williams __func__, 6146f231ddaSDan Williams isci_request, 6156f231ddaSDan Williams old_state); 6166f231ddaSDan Williams 6176f231ddaSDan Williams return old_state; 6186f231ddaSDan Williams } 6196f231ddaSDan Williams 6206f231ddaSDan Williams /** 6216f231ddaSDan Williams * isci_request_change_started_to_aborted() - This function sets the status of 6226f231ddaSDan Williams * the request object. 6236f231ddaSDan Williams * @request: This parameter points to the isci_request object 6246f231ddaSDan Williams * @completion_ptr: This parameter is saved as the kernel completion structure 6256f231ddaSDan Williams * signalled when the old request completes. 6266f231ddaSDan Williams * 6276f231ddaSDan Williams * state previous to any change. 6286f231ddaSDan Williams */ 6296f231ddaSDan Williams static inline enum isci_request_status isci_request_change_started_to_aborted( 6306f231ddaSDan Williams struct isci_request *isci_request, 6316f231ddaSDan Williams struct completion *completion_ptr) 6326f231ddaSDan Williams { 6336f231ddaSDan Williams return isci_request_change_started_to_newstate( 6346f231ddaSDan Williams isci_request, completion_ptr, aborted 6356f231ddaSDan Williams ); 6366f231ddaSDan Williams } 6376f231ddaSDan Williams /** 6386f231ddaSDan Williams * isci_request_free() - This function frees the request object. 6396f231ddaSDan Williams * @isci_host: This parameter specifies the ISCI host object 6406f231ddaSDan Williams * @isci_request: This parameter points to the isci_request object 6416f231ddaSDan Williams * 6426f231ddaSDan Williams */ 6436f231ddaSDan Williams static inline void isci_request_free( 6446f231ddaSDan Williams struct isci_host *isci_host, 6456f231ddaSDan Williams struct isci_request *isci_request) 6466f231ddaSDan Williams { 6476cb4d6b3SBartosz Barcinski if (!isci_request) 6486cb4d6b3SBartosz Barcinski return; 6496f231ddaSDan Williams 6506f231ddaSDan Williams /* release the dma memory if we fail. */ 6516f231ddaSDan Williams dma_pool_free(isci_host->dma_pool, isci_request, 6526f231ddaSDan Williams isci_request->request_daddr); 6536f231ddaSDan Williams } 6546f231ddaSDan Williams 6556f231ddaSDan Williams 6566f231ddaSDan Williams /* #define ISCI_REQUEST_VALIDATE_ACCESS 6576f231ddaSDan Williams */ 6586f231ddaSDan Williams 6596f231ddaSDan Williams #ifdef ISCI_REQUEST_VALIDATE_ACCESS 6606f231ddaSDan Williams 6616f231ddaSDan Williams static inline 6626f231ddaSDan Williams struct sas_task *isci_request_access_task(struct isci_request *isci_request) 6636f231ddaSDan Williams { 6646f231ddaSDan Williams BUG_ON(isci_request->ttype != io_task); 6656f231ddaSDan Williams return isci_request->ttype_ptr.io_task_ptr; 6666f231ddaSDan Williams } 6676f231ddaSDan Williams 6686f231ddaSDan Williams static inline 6696f231ddaSDan Williams struct isci_tmf *isci_request_access_tmf(struct isci_request *isci_request) 6706f231ddaSDan Williams { 6716f231ddaSDan Williams BUG_ON(isci_request->ttype != tmf_task); 6726f231ddaSDan Williams return isci_request->ttype_ptr.tmf_task_ptr; 6736f231ddaSDan Williams } 6746f231ddaSDan Williams 6756f231ddaSDan Williams #else /* not ISCI_REQUEST_VALIDATE_ACCESS */ 6766f231ddaSDan Williams 6776f231ddaSDan Williams #define isci_request_access_task(RequestPtr) \ 6786f231ddaSDan Williams ((RequestPtr)->ttype_ptr.io_task_ptr) 6796f231ddaSDan Williams 6806f231ddaSDan Williams #define isci_request_access_tmf(RequestPtr) \ 6816f231ddaSDan Williams ((RequestPtr)->ttype_ptr.tmf_task_ptr) 6826f231ddaSDan Williams 6836f231ddaSDan Williams #endif /* not ISCI_REQUEST_VALIDATE_ACCESS */ 6846f231ddaSDan Williams 6856f231ddaSDan Williams 6866f231ddaSDan Williams int isci_request_alloc_tmf( 6876f231ddaSDan Williams struct isci_host *isci_host, 6886f231ddaSDan Williams struct isci_tmf *isci_tmf, 6896f231ddaSDan Williams struct isci_request **isci_request, 6906f231ddaSDan Williams struct isci_remote_device *isci_device, 6916f231ddaSDan Williams gfp_t gfp_flags); 6926f231ddaSDan Williams 6936f231ddaSDan Williams 6946f231ddaSDan Williams int isci_request_execute( 6956f231ddaSDan Williams struct isci_host *isci_host, 6966f231ddaSDan Williams struct sas_task *task, 6976f231ddaSDan Williams struct isci_request **request, 6986f231ddaSDan Williams gfp_t gfp_flags); 6996f231ddaSDan Williams 7006f231ddaSDan Williams /** 7016f231ddaSDan Williams * isci_request_unmap_sgl() - This function unmaps the DMA address of a given 7026f231ddaSDan Williams * sgl 7036f231ddaSDan Williams * @request: This parameter points to the isci_request object 7046f231ddaSDan Williams * @*pdev: This Parameter is the pci_device struct for the controller 7056f231ddaSDan Williams * 7066f231ddaSDan Williams */ 7076f231ddaSDan Williams static inline void isci_request_unmap_sgl( 7086f231ddaSDan Williams struct isci_request *request, 7096f231ddaSDan Williams struct pci_dev *pdev) 7106f231ddaSDan Williams { 7116f231ddaSDan Williams struct sas_task *task = isci_request_access_task(request); 7126f231ddaSDan Williams 7136f231ddaSDan Williams dev_dbg(&request->isci_host->pdev->dev, 7146f231ddaSDan Williams "%s: request = %p, task = %p,\n" 7156f231ddaSDan Williams "task->data_dir = %d, is_sata = %d\n ", 7166f231ddaSDan Williams __func__, 7176f231ddaSDan Williams request, 7186f231ddaSDan Williams task, 7196f231ddaSDan Williams task->data_dir, 7206f231ddaSDan Williams sas_protocol_ata(task->task_proto)); 7216f231ddaSDan Williams 7226f231ddaSDan Williams if ((task->data_dir != PCI_DMA_NONE) && 7236f231ddaSDan Williams !sas_protocol_ata(task->task_proto)) { 7246f231ddaSDan Williams if (task->num_scatter == 0) 7256f231ddaSDan Williams /* 0 indicates a single dma address */ 7266f231ddaSDan Williams dma_unmap_single( 7276f231ddaSDan Williams &pdev->dev, 7286f231ddaSDan Williams request->zero_scatter_daddr, 7296f231ddaSDan Williams task->total_xfer_len, 7306f231ddaSDan Williams task->data_dir 7316f231ddaSDan Williams ); 7326f231ddaSDan Williams 7336f231ddaSDan Williams else /* unmap the sgl dma addresses */ 7346f231ddaSDan Williams dma_unmap_sg( 7356f231ddaSDan Williams &pdev->dev, 7366f231ddaSDan Williams task->scatter, 7376f231ddaSDan Williams request->num_sg_entries, 7386f231ddaSDan Williams task->data_dir 7396f231ddaSDan Williams ); 7406f231ddaSDan Williams } 7416f231ddaSDan Williams } 7426f231ddaSDan Williams 7436f231ddaSDan Williams /** 7446f231ddaSDan Williams * isci_request_io_request_get_next_sge() - This function is called by the sci 7456f231ddaSDan Williams * core to retrieve the next sge for a given request. 7466f231ddaSDan Williams * @request: This parameter is the isci_request object. 7476f231ddaSDan Williams * @current_sge_address: This parameter is the last sge retrieved by the sci 7486f231ddaSDan Williams * core for this request. 7496f231ddaSDan Williams * 7506f231ddaSDan Williams * pointer to the next sge for specified request. 7516f231ddaSDan Williams */ 7526f231ddaSDan Williams static inline void *isci_request_io_request_get_next_sge( 7536f231ddaSDan Williams struct isci_request *request, 7546f231ddaSDan Williams void *current_sge_address) 7556f231ddaSDan Williams { 7566f231ddaSDan Williams struct sas_task *task = isci_request_access_task(request); 7576f231ddaSDan Williams void *ret = NULL; 7586f231ddaSDan Williams 7596f231ddaSDan Williams dev_dbg(&request->isci_host->pdev->dev, 7606f231ddaSDan Williams "%s: request = %p, " 7616f231ddaSDan Williams "current_sge_address = %p, " 7626f231ddaSDan Williams "num_scatter = %d\n", 7636f231ddaSDan Williams __func__, 7646f231ddaSDan Williams request, 7656f231ddaSDan Williams current_sge_address, 7666f231ddaSDan Williams task->num_scatter); 7676f231ddaSDan Williams 7686f231ddaSDan Williams if (!current_sge_address) /* First time through.. */ 7696f231ddaSDan Williams ret = task->scatter; /* always task->scatter */ 7706f231ddaSDan Williams else if (task->num_scatter == 0) /* Next element, if num_scatter == 0 */ 7716f231ddaSDan Williams ret = NULL; /* there is only one element. */ 7726f231ddaSDan Williams else 7736f231ddaSDan Williams ret = sg_next(current_sge_address); /* sg_next returns NULL 7746f231ddaSDan Williams * for the last element 7756f231ddaSDan Williams */ 7766f231ddaSDan Williams 7776f231ddaSDan Williams dev_dbg(&request->isci_host->pdev->dev, 7786f231ddaSDan Williams "%s: next sge address = %p\n", 7796f231ddaSDan Williams __func__, 7806f231ddaSDan Williams ret); 7816f231ddaSDan Williams 7826f231ddaSDan Williams return ret; 7836f231ddaSDan Williams } 7846f231ddaSDan Williams 785f1f52e75SDan Williams void isci_terminate_pending_requests(struct isci_host *isci_host, 7866f231ddaSDan Williams struct isci_remote_device *isci_device, 7876f231ddaSDan Williams enum isci_request_status new_request_state); 788f1f52e75SDan Williams enum sci_status scic_task_request_construct(struct scic_sds_controller *scic, 789f1f52e75SDan Williams struct scic_sds_remote_device *sci_dev, 790f1f52e75SDan Williams u16 io_tag, 791f1f52e75SDan Williams struct scic_sds_request *sci_req); 792f1f52e75SDan Williams enum sci_status scic_task_request_construct_ssp(struct scic_sds_request *sci_req); 793f1f52e75SDan Williams enum sci_status scic_task_request_construct_sata(struct scic_sds_request *sci_req); 794f1f52e75SDan Williams enum sci_status scic_io_request_construct_smp(struct scic_sds_request *sci_req); 795f1f52e75SDan Williams void scic_stp_io_request_set_ncq_tag(struct scic_sds_request *sci_req, u16 ncq_tag); 796f1f52e75SDan Williams void scic_sds_smp_request_copy_response(struct scic_sds_request *sci_req); 7976f231ddaSDan Williams #endif /* !defined(_ISCI_REQUEST_H_) */ 798