summaryrefslogtreecommitdiff
path: root/network/wlan/WDI/COMMON/Frame_Buf.h
blob: 3fc59a51b8ae8421fbea2704d805cc27983d5cd4 (plain)
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
//---------------------------------------------------------------------------
//
// Copyright (c) 2014 Realtek Semiconductor, Inc. All rights reserved.
// 
//---------------------------------------------------------------------------
// Description:
//		
//

#ifndef __INC_FRAME_BUF_H
#define __INC_FRAME_BUF_H

//-----------------------------------------------------------------------------
// Data
//-----------------------------------------------------------------------------

// Capacity
#define FRAME_BUF_CAP_UNKNOWN 0xFFFF

// Flags
#define FRAME_BUF_FLAG_EXTERNAL_BUF		BIT0

// The internal structure the exported functions operat on.
typedef struct _FRAME_BUF
{
	const u1Byte				*sig;		// signature
	OCTET_STRING				os;			// the buf
	u2Byte						cap; 		// capacity
	u4Byte						flags;		// flags
	u4Byte						dbgLevel; 	// debug level
}FRAME_BUF;

//-----------------------------------------------------------------------------
// Function
//-----------------------------------------------------------------------------

const u1Byte *
FrameBuf_Head(
	IN  const FRAME_BUF			*pBuf
	);

u1Byte *
FrameBuf_MHead(
	IN  FRAME_BUF				*pBuf
	);

const u1Byte *
FrameBuf_Tail(
	IN  const FRAME_BUF			*pBuf
	);

u1Byte *
FrameBuf_MTail(
	IN  FRAME_BUF				*pBuf
	);

u2Byte
FrameBuf_Length(
	IN  const FRAME_BUF			*pBuf
	);

u2Byte
FrameBuf_TailRoom(
	IN  const FRAME_BUF			*pBuf
	);

VOID
FrameBuf_Dump(
	IN  const FRAME_BUF			*pBuf,
	IN  u8Byte					dbgComp,
	IN  u4Byte					dbgLevel,
	IN  const char *			strTitle
	);

VOID
FrameBuf_DumpFrom(
	IN  const FRAME_BUF			*pBuf,
	IN  const u1Byte			*pHead,
	IN  u8Byte					dbgComp,
	IN  u4Byte					dbgLevel,
	IN  const char *			strTitle
	);

VOID
FrameBuf_Init(
	IN  u2Byte					cap,
	IN  u2Byte					len,
	IN  u1Byte					*buf,
	OUT FRAME_BUF				*pBuf
	);

FRAME_BUF *
FrameBuf_Alloc(
	IN  u2Byte					cap
	);

VOID
FrameBuf_Free(
	IN  FRAME_BUF				*pBuf
	);

FRAME_BUF *
FrameBuf_Clone(
	IN  const FRAME_BUF			*pBuf
	);

BOOLEAN
FrameBuf_Append(
	IN  FRAME_BUF				*pDest,
	IN  const FRAME_BUF			*pSrc
	);

u1Byte *
FrameBuf_Add(
	IN  FRAME_BUF				*pBuf,
	IN  u2Byte					size
	);

u1Byte *
FrameBuf_Minus(
	IN  FRAME_BUF				*pBuf,
	IN  u2Byte					size
	);

BOOLEAN
FrameBuf_Add_u1(
	IN  FRAME_BUF				*pBuf,
	IN  u1Byte					data
	);

BOOLEAN
FrameBuf_Add_le_u2(
	IN  FRAME_BUF				*pBuf,
	IN  u2Byte					data
	);

BOOLEAN
FrameBuf_Add_le_u4(
	IN  FRAME_BUF				*pBuf,
	IN  u4Byte					data
	);

BOOLEAN
FrameBuf_Add_be_u2(
	IN  FRAME_BUF				*pBuf,
	IN  u2Byte					data
	);

BOOLEAN
FrameBuf_Add_be_u4(
	IN  FRAME_BUF				*pBuf,
	IN  u4Byte					data
	);

BOOLEAN
FrameBuf_Add_Data(
	IN  FRAME_BUF				*pBuf,
	IN  const VOID				*data,
	IN  u2Byte					len
	);

u4Byte
FrameBuf_Flags(
	IN  const FRAME_BUF			*pBuf
	);

u2Byte
FrameBuf_Cap(
	IN  const FRAME_BUF			*pBuf
	);

u4Byte
FrameBuf_DbgLevel(
	IN  const FRAME_BUF			*pBuf
	);

VOID
FrameBuf_SetDbgLevel(
	IN  FRAME_BUF				*pBuf,
	IN  u4Byte					dbgLevel
	);

#endif	// #ifndef __INC_FRAME_BUF_H