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
|
/*
* RxBuf.h
*
* Copyright(c) 1998 - 2009 Texas Instruments. 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 Texas Instruments 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.
*/
/***************************************************************************/
/* */
/* MODULE: buf.h */
/* PURPOSE: manages the allocation/free and field access of the BUF */
/* */
/***************************************************************************/
#ifndef _BUF_H_
#define _BUF_H_
#include "tidef.h"
#include "queue.h"
#include "public_descriptors.h"
#define WSPI_PAD_BYTES 16 /* Add padding before data buffer for WSPI overhead */
#define PAYLOAD_ALIGN_PAD_BYTES 4 /* Add an extra word for alignment the MAC payload in case of QoS MSDU */
/**
* \brief Buffer for Tx/Rx packets
*/
typedef void BUF, *PBUF;
/* Packet types */
/**
* \def RX_BUF_DATA
* \brief Macro which gets a pointer to BUF packet header and returns the pointer to the start address of the WLAN packet's data
*/
#define RX_BUF_DATA(pBuf) ((void*)((TI_UINT8 *)pBuf + sizeof(RxIfDescriptor_t)))
/**
* \def RX_BUF_LEN
* \brief Macro which gets a pointer to BUF packet header and returns the buffer length (without Rx Descriptor) of the WLAN packet
*/
#define RX_BUF_LEN(pBuf) ( (((RxIfDescriptor_t *)(pBuf))->length << 2) - \
((RxIfDescriptor_t *)(pBuf))->extraBytes - \
sizeof(RxIfDescriptor_t) )
/**
* \def RX_ETH_PKT_DATA
* \brief Macro which gets a pointer to BUF packet header and returns the pointer to the start address of the ETH packet's data
*/
#define RX_ETH_PKT_DATA(pBuf) *((void **)(((TI_UINT32)pBuf + sizeof(RxIfDescriptor_t) + 2) & ~3))
/**
* \def RX_ETH_PKT_LEN
* \brief Macro which gets a pointer to BUF packet header and returns the buffer length (without Rx Descriptor) of the ETH packet
*/
#define RX_ETH_PKT_LEN(pBuf) *((TI_UINT32 *)(((TI_UINT32)pBuf + sizeof(RxIfDescriptor_t) + 6) & ~3))
/** \brief BUF Allocation
*
* \param hOs - OS module object handle
* \param len - Length of allocated WBUF
* \param ePacketClassTag - The RX packet type (used only in EMP)
* \return On success: Pointer to WBUF ; Otherwise: NULL
*
* \par Description
* This function allocates BUF element for Tx/Rx packet
*
* \sa
*/
BUF* RxBufAlloc (TI_HANDLE hOs, TI_UINT32 len, PacketClassTag_e ePacketClassTag);
/** \brief BUF Free
*
* \param hOs - OS module object handle
* \param pWbuf - Pointer to WBUF which was previously created by user
* \return void
*
* \par Description
* This function frees the memory allocated for BUF element
*
* \sa
*/
void RxBufFree (TI_HANDLE hOs, void* pBuf);
/** \brief BUF Free
*
* \param hOs - OS module object handle
* \param pWbuf - Pointer to WBUF which was previously created by user
* \return void
*
* \par Description
* This function increment the start address of data held in BUF element in len.
*
* \sa
*/
void RxBufReserve (TI_HANDLE hOs, void* pBuf, TI_UINT32 len);
#endif
|
