drivers/scsi/isci/core/scu_unsolicited_frame.h

   1 /*
   2  * This file is provided under a dual BSD/GPLv2 license.  When using or
   3  * redistributing this file, you may do so under either license.
   4  *
   5  * GPL LICENSE SUMMARY
   6  *
   7  * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of version 2 of the GNU General Public License as
  11  * published by the Free Software Foundation.
  12  *
  13  * This program is distributed in the hope that it will be useful, but
  14  * WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
  21  * The full GNU General Public License is included in this distribution
  22  * in the file called LICENSE.GPL.
  23  *
  24  * BSD LICENSE
  25  *
  26  * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
  27  * All rights reserved.
  28  *
  29  * Redistribution and use in source and binary forms, with or without
  30  * modification, are permitted provided that the following conditions
  31  * are met:
  32  *
  33  *   * Redistributions of source code must retain the above copyright
  34  *     notice, this list of conditions and the following disclaimer.
  35  *   * Redistributions in binary form must reproduce the above copyright
  36  *     notice, this list of conditions and the following disclaimer in
  37  *     the documentation and/or other materials provided with the
  38  *     distribution.
  39  *   * Neither the name of Intel Corporation nor the names of its
  40  *     contributors may be used to endorse or promote products derived
  41  *     from this software without specific prior written permission.
  42  *
  43  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  44  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  45  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  46  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  47  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  48  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  49  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  50  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  51  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  52  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  53  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  54  */
  55
  56 /**
  57  * This field defines the SCU format of an unsolicited frame (UF).  A UF is a
  58  *    frame received by the SCU for which there is no known corresponding task
  59  *    context (TC).
  60  *
  61  *
  62  */
  63
  64 #ifndef _SCU_UNSOLICITED_FRAME_H_
  65 #define _SCU_UNSOLICITED_FRAME_H_
  66
  67 #include "sci_types.h"
  68
  69 /**
  70  *
  71  *
  72  * This constant defines the number of DWORDS found the unsolicited frame
  73  * header data member.
  74  */
  75 #define SCU_UNSOLICITED_FRAME_HEADER_DATA_DWORDS 15
  76
  77 /**
  78  * struct scu_unsolicited_frame_header -
  79  *
  80  * This structure delineates the format of an unsolicited frame header. The
  81  * first DWORD are UF attributes defined by the silicon architecture. The data
  82  * depicts actual header information received on the link.
  83  */
  84 struct scu_unsolicited_frame_header {
  85         /**
  86          * This field indicates if there is an Initiator Index Table entry with
  87          * which this header is associated.
  88          */
  89         u32 iit_exists:1;
  90
  91         /**
  92          * This field simply indicates the protocol type (i.e. SSP, STP, SMP).
  93          */
  94         u32 protocol_type:3;
  95
  96         /**
  97          * This field indicates if the frame is an address frame (IAF or OAF)
  98          * or if it is a information unit frame.
  99          */
 100         u32 is_address_frame:1;
 101
 102         /**
 103          * This field simply indicates the connection rate at which the frame
 104          * was received.
 105          */
 106         u32 connection_rate:4;
 107
 108         u32 reserved:23;
 109
 110         /**
 111          * This field represents the actual header data received on the link.
 112          */
 113         u32 data[SCU_UNSOLICITED_FRAME_HEADER_DATA_DWORDS];
 114
 115 };
 116
 117 #endif /* _SCU_UNSOLICITED_FRAME_H_ */