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