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