1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
|
/******************************************************************************
* @file icp_hssacc_tdm_io_queue_entry.h
*
* @description Content of this file contains the definition and access
* macros for the TDM I/O Queue Entry format
*
* @ingroup icp_HssAcc
*
* @Revision 1.0
*
* @par
* This file is provided under a dual BSD/GPLv2 license. When using or
* redistributing this file, you may do so under either license.
*
* GPL LICENSE SUMMARY
*
* Copyright(c) 2007,2008,2009 Intel Corporation. All rights reserved.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of version 2 of the GNU General Public License as
* published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
* The full GNU General Public License is included in this distribution
* in the file called LICENSE.GPL.
*
* Contact Information:
* Intel Corporation
*
* BSD LICENSE
*
* Copyright(c) 2007,2008,2009 Intel Corporation. All rights reserved.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
* * Neither the name of Intel Corporation nor the names of its
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
*
*
*
*****************************************************************************/
#ifndef ICP_HSSACC_TDM_IO_QUEUE_ENTRY_H
#define ICP_HSSACC_TDM_IO_QUEUE_ENTRY_H
/*****************************************************************************
* Definition of the Channel descriptor format
*
*****************************************************************************/
typedef struct icp_hssacc_chan_desc_s
{
/* In order to handle both Little and Big Endianness correctly,
this data struct contains the Length split into MSB and LSB fields. */
uint8_t currBufLength_LSB;
uint8_t currBufLength_MSB;
uint8_t status;
uint8_t channelId;
} icp_hssacc_chan_desc_t;
/*****************************************************************************
* Definition of the Queue Entry format for Tx and RxFree Queues
*
*****************************************************************************/
typedef struct icp_hssacc_tdm_io_queue_entry_s
{
/* this union allows us to manipulate and move around the entire data
struct as a single word,thus saving instructions for copies */
union {
icp_hssacc_chan_desc_t strct;
uint32_t word;
} descriptor;
void * currBufData;
uint32_t packetLengthBytes;
IX_OSAL_MBUF * currBuf;
} icp_hssacc_tdm_io_queue_entry_t;
/*****************************************************************************
* Definition of the TDM I/O private section of the OSAL Buffer
*
*****************************************************************************/
typedef struct icp_hssacc_osal_mbuf_tdm_io_section_s
{
icp_hssacc_tdm_io_queue_entry_t tdm_io_entry;
IX_OSAL_MBUF * pNextBuf;
uint32_t reserved[3];
} icp_hssacc_osal_mbuf_tdm_io_section_t;
/*****************************************************************************
* Macros for accessing the different fields of a Queue Entry
*
*****************************************************************************/
#define ICP_TDM_IO_Q_ENTRY_CHANNEL_ID(entryPtr) \
((entryPtr)->descriptor.strct.channelId)
#define ICP_TDM_IO_Q_ENTRY_STATUS(entryPtr) (entryPtr->descriptor.strct.status)
#define ICP_TDM_IO_Q_ENTRY_CURR_BUF_LEN_MSB(entryPtr) \
((entryPtr)->descriptor.strct.currBufLength_MSB)
#define ICP_TDM_IO_Q_ENTRY_CURR_BUF_LEN_LSB(entryPtr) \
((entryPtr)->descriptor.strct.currBufLength_LSB)
#define ICP_TDM_IO_Q_ENTRY_DATA(entryPtr) ((entryPtr)->currBufData)
#define ICP_TDM_IO_Q_ENTRY_PKT_LEN(entryPtr) ((entryPtr)->packetLengthBytes)
#define ICP_TDM_IO_Q_ENTRY_OSAL_MBUF(entryPtr) ((entryPtr)->currBuf)
/*****************************************************************************
* Macros for accessing the different fields of the TDM I/O Unit private section
* of the OSAL Buffer
*
*****************************************************************************/
#define ICP_OSAL_MBUF_TDM_SECT_CHANNEL_ID(mbufPtr) \
(ICP_TDM_IO_Q_ENTRY_CHANNEL_ID((&((mbufPtr)->tdm_io_entry))))
#define ICP_OSAL_MBUF_TDM_SECT_STATUS(mbufPtr) \
(ICP_TDM_IO_Q_ENTRY_STATUS((&((mbufPtr)->tdm_io_entry))))
#define ICP_OSAL_MBUF_TDM_SECT_CURR_BUF_LEN_MSB(mbufPtr) \
(ICP_TDM_IO_Q_ENTRY_CURR_BUF_LEN_MSB((&((mbufPtr)->tdm_io_entry))))
#define ICP_OSAL_MBUF_TDM_SECT_CURR_BUF_LEN_LSB(mbufPtr) \
(ICP_TDM_IO_Q_ENTRY_CURR_BUF_LEN_LSB((&((mbufPtr)->tdm_io_entry))))
#define ICP_OSAL_MBUF_TDM_SECT_DATA(mbufPtr) \
(ICP_TDM_IO_Q_ENTRY_DATA((&((mbufPtr)->tdm_io_entry))))
#define ICP_OSAL_MBUF_TDM_SECT_PKT_LEN(mbufPtr) \
(ICP_TDM_IO_Q_ENTRY_PKT_LEN((&((mbufPtr)->tdm_io_entry))))
#define ICP_OSAL_MBUF_TDM_SECT_NEXT_BUF(mbufPtr) \
((mbufPtr)->pNextBuf)
#define ICP_OSAL_MBUF_TDM_SECT_OSAL_MBUF_START(mbufPtr) \
(ICP_TDM_IO_Q_ENTRY_OSAL_MBUF((&((mbufPtr)->tdm_io_entry))))
/*****************************************************************************
* Macros for handling the Packet Length field. these are used to manipulate
* the endianness of the field.
*
*****************************************************************************/
#define ICP_OSAL_MBUF_TDM_SECT_LEN_MASK 0xFF
#define ICP_OSAL_MBUF_TDM_SECT_LEN_MSB_OFFSET 8
/* These macros will return as a byte number the MSB and LSB
respectively of a 2 byte packet length field */
#define ICP_OSAL_MBUF_PKT_LEN_MSB(len) ((len >> ICP_OSAL_MBUF_TDM_SECT_LEN_MSB_OFFSET) & ICP_OSAL_MBUF_TDM_SECT_LEN_MASK)
#define ICP_OSAL_MBUF_PKT_LEN_LSB(len) (len & ICP_OSAL_MBUF_TDM_SECT_LEN_MASK)
#endif
|
