scsi/isci/scu_task_context.h

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.
9  * This program is free software; you can redistribute it and/or modify
13  * This program is distributed in the hope that it will be useful, but
19  * along with this program; if not, write to the Free Software
21  * The full GNU General Public License is included in this distribution
34  *     notice, this list of conditions and the following disclaimer.
36  *     notice, this list of conditions and the following disclaimer in
41  *     from this software without specific prior written permission.
43  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
53  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
60  * This file contains the structures and constants for the SCU hardware task
68  * enum scu_ssp_task_type - This enumberation defines the various SSP task
84  * enum scu_sata_task_type - This enumeration defines the various SATA task
139  * This priority is used when there is no priority request for this request.
146  * This priority indicates that the task should be scheduled to the head of the
155  * This priority indicates that the task will be executed before all
164  * This task priority is reserved and should not be used.
284  * SCU_TASK_CONTEXT_PROTOCOL SCU Task context protocol types this is uesd to
293  * struct ssp_task_context - This is the SCU hardware definition for an SSP
327  * struct stp_task_context - This is the SCU hardware definition for an STP
355 	u32 data_offset; /* TODO: What is this used for? */
359  * struct smp_task_context - This is the SCU hardware definition for an SMP
389  * struct primitive_task_context - This is the SCU hardware definition used
397 	 * This field is the control word and it must be 0.
403 	 * This field specifies the primitive that is to be transmitted.
435  * struct scu_sgl_element - This structure represents a single SCU defined SGL
443 	 * This field is the upper 32 bits of the 64 bit physical address.
448 	 * This field is the lower 32 bits of the 64 bit physical address.
453 	 * This field is the number of bytes to transfer.
458 	 * This field is the address modifier to be used when a virtual function is
469  * struct scu_sgl_element_pair - This structure is the SCU hardware definition
479 	 * This field is the SGL element A of the SGL pair.
485 	 * This field is the SGL element B of the SGL pair.
491 	 * This field is the upper 32 bits of the 64 bit address to the next SGL
497 	 * This field is the lower 32 bits of the 64 bit address to the next SGL
505  * struct transport_snapshot - This structure is the SCU hardware scratch area
506  *    for the task context. This is set to 0 by the driver but can be read by
531  * struct scu_task_context - This structure defines the contents of the SCU
540 	 * This field must be encoded to one of the valid SCU task priority values
548 	 * This field must be set to true if this is an initiator generated request.
554 	 * This field must be set to one of the valid connection rates valid values
560 	 * This field muse be programed when generating an SMP response since the SMP
566 	 * This field must contain the logical port for the task request.
571 	 * This field must be set to one of the SCU_TASK_CONTEXT_PROTOCOL values
580 	 * This filed must be set to the TCi allocated for this task
585 	 * This field is reserved and must be set to 0x00
590 	 * For a normal task request this must be set to 0.  If this is an abort of
591 	 * this task request it must be set to 1.
596 	 * This field must be set to true for the SCU hardware to process the task.
601 	 * This field must be set to SCU_TASK_CONTEXT_TYPE
607 	 * This field contains the RNi that is the target of this request.
612 	 * This field is programmed if this is a mirrored request, which we are not
618 	 * This field is programmed with the direction of the SATA reqeust
625 	 * This field is programmsed with one of the following SCU_COMMAND_CODE
634 	 * This field is set to true if the remote node should be suspended.
635 	 * This bit is only valid for SSP & SMP target devices.
640 	 * This field is programmed with one of the following command type codes
663 	 * This field is reserved and the must be set to 0x00
668 	 * This field is set to true when TLR is to be enabled
673 	 * This is field specifies if the SCU DMAs a response frame to host
679 	 * This field indicates if the SCU should DMA the response frame to
685 	 * This field is set to true when strict ordering is to be enabled
690 	 * This field indicates the type of endianess to be utilized for the
697 	 * This field is reserved and the driver should set to 0x00
702 	 * This field is set to true when the SCU hardware task timeout control is to
708 	 * This field is reserved and the driver should set it to 0x00
713 	 * This field should be set to true when block guard is to be enabled
718 	 * This field is reserved and the driver should set to 0x00
724 	 * This field is the address modifier for this io request it should be
735 	 * If this is a mirrored request the logical port index for the mirrored RNi
741 	 * This field is reserved and the driver must set it to 0x00
746 	 * This field must be set to true if the mirrored request processing is to be
753 	 * This field is the command iu length in dwords
758 	 * This is the target TLR enable bit it must be set to 0 when creatning the
764 	 * This field is reserved and the driver must set it to 0x00
769 	 * This is the maximum burst size that the SCU hardware will send in one
777 	 * This filed is set to the number of bytes to be transfered in the request.
782 	 * This field is reserved and the driver should set it to 0x00
788 	 * This union provides for the protocol specif part of the SCU Task Context.
794 	 * This field is the upper 32 bits of the 64 bit physical address of the
800 	 * This field is the lower 32 bits of the 64 bit physical address of the
807 	 * This field is the upper 32 bits of the 64 bit physical address of the
813 	 * This field is the lower 32 bits of the 64 bit physical address of the
820 	 * This field is set to the task phase of the SCU hardware. The driver must
821 	 * set this to 0x01
826 	 * This field is set to the transport layer task status.  The driver must set
827 	 * this to 0x00
832 	 * This field is used during initiator write TLR
837 	 * This field is set the maximum number of retries for a STP non-data FIS
842 	 * This field is reserved and the driver must set it to 0x00
847 	 * This field is used by the SCU TL to determine when to take a snapshot when
858 	 * This field is reserved and the driver must set it to 0x00
880 	 * This field is the first SGL element pair found in the TC data structure.
885 	 * This field is the second SGL element pair found in the TC data structure.