Aim MIL-STD-1553 - GENERAL I;O (GENIO) FUNCTIONS

MIL-STD-1553 Reference Manual
409
Chapter 9 – Bus Monitor Functions
9.1.42 ApiCreateScopeBuffer
Prototype:
TY_API_SCOPE_BUFFER* ApiCreateScopeBuffer(
AiUInt32 ulModuleHandle,
AiUInt32 ulID,
TY_API_SCOPE_BUFFER_TYPE eBufferType,
TY_API_SCOPE_BUFFER_HANDLER pBufferHandler,
void* pvUserData);
Purpose:
This function allocates a scope buffer which can be used as input to the function
ApiProvideScopeBuffers. The MILScope data will be transferred directly into this
buffer with a DMA transfer. The buffer will be allocated with the required size
according to the MILScope setup. Before this function is called the function
ApiCmdScopeSetup must be called.
Note: This function is only usable with AIM’s APE MIL-Scope module.
I
I
n
n
p
p
u
u
t
t
u
u
l
l
I
I
d
d
User-definable ID of the buffer.
T
T
Y
Y
_
_
A
A
P
P
I
I
_
_
S
S
C
C
O
O
P
P
E
E
_
_
B
B
U
U
F
F
F
F
E
E
R
R
_
_
T
T
Y
Y
P
P
E
E
e
e
B
B
u
u
f
f
f
f
e
e
r
r
T
T
y
y
p
p
e
e
The MIL channel the buffer is determined for.
T
T
Y
Y
_
_
A
A
P
P
I
I
_
_
S
S
C
C
O
O
P
P
E
E
_
_
B
B
U
U
F
F
F
F
E
E
R
R
_
_
H
H
A
A
N
N
D
D
L
L
E
E
R
R
p
p
B
B
u
u
f
f
f
f
e
e
r
r
H
H
a
a
n
n
d
d
l
l
e
e
r
r
Handler function, which is called when the buffer is full. Parameters are the module handle of the board and
a pointer to the buffer that is ready. See description of ApiProvideScopeBuffer.
v
v
o
o
i
i
d
d
*
*
p
p
v
v
U
U
s
s
e
e
r
r
D
D
a
a
t
t
a
a
Pointer to user definable data which is attached to the scope buffer. This data can be accessed in the scope
buffer handler when buffer is completed or canceled.
O
O
u
u
t
t
p
p
u
u
t
t
N
N
o
o
n
n
e
e
Return Value
T
T
Y
Y
_
_
A
A
P
P
I
I
_
_
S
S
C
C
O
O
P
P
E
E
_
_
B
B
U
U
F
F
F
F
E
E
R
R
*
*
Pointer to the created scope buffer structure. On failure, NULL is returned. See description of
ApiProvideScopeBuffer.
Enum Value
Description
SCOPE_BUFFER_PRIMARY
Buffer is for data on primary channel
SCOPE_BUFFER_SECONDARY
Buffer is for data on secondary channel