Aim MIL-STD-1553 - Apiprovidescopebuffers

MIL-STD-1553 Reference Manual
412
Chapter 9 – Bus Monitor Functions
9.1.45 ApiProvideScopeBuffers
Prototype:
AiInt16 ApiProvideScopeBuffers(
AiUInt32 ulModuleHandle,
AiUInt32 ulNumBuffers,
TY_API_SCOPE_BUFFER* paxBuffers);
Purpose:
This function provides one ore more buffers created with ApiCreateScopeBuffer or
ApiCreateScopeBufferList to the system driver. The buffers will be directly filled with
data through a DMA transfer. Each buffer can have his own handler function
installed which is called as soon as the buffer is full. The handler calls are
automatically searialized on board level so that only one handler is called at a time.
Note: This function is only usable with AIM’s APE MIL-Scope module.
I
I
n
n
p
p
u
u
t
t
A
A
i
i
U
U
I
I
n
n
t
t
3
3
2
2
u
u
l
l
N
N
u
u
m
m
B
B
u
u
f
f
f
f
e
e
r
r
s
s
Number of buffers in the array paxBuffers.
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
*
*
p
p
a
a
x
x
B
B
u
u
f
f
f
f
e
e
r
r
s
s
[
[
]
]
Array of pointers to TY_API_SCOPE_BUFFER structure elements, each of them containing information
about one provided buffer.
typedef enum API_SCOPE_BUFFER_TYPE
{
SCOPE_BUFFER_PRIMARY = 0;
SCOPE_BUFFER_SECONDARY;
} TY_API_SCOPE_BUFFER_TYPE;
typedef struct ty_api_scope_buffer
{
AiUInt32 ulID;
TY_API_SCOPE_BUFFER_TYPE eBufferType;
void* pvBuffer;
AiUInt32 ulBufferSize;
TY_API_SCOPE_BUFFER_FLAGS ulFlags;
AiUInt32 ulDataSize;
AiUInt32 ulTriggerId;
TY_API_SCOPE_BUFFER_HANLDER pBufferHandler,
void* pvUserData );
} TY_API_SCOPE_BUFFER;
A
A
i
i
U
U
I
I
n
n
t
t
3
3
2
2
u
u
l
l
I
I
D
D
ID of the buffer that can be defined by user for his own use.
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.
Enum Value
Description
SCOPE_BUFFER_PRIMARY
Buffer is for data on primary channel
SCOPE_BUFFER_SECONDARY
Buffer is for data on secondary channel