Aim MIL-STD-1553 - Apicmdloadsrec

MIL-STD-1553 Reference Manual
83
Chapter 3 – System Functions
3.1.9 ApiCmdLoadSRec
Prototype:
AiInt16 ApiCmdLoadSRec( AiUInt32 ul_ModuleHandle, AiUInt8 mode, AiUInt8 cnt,
AiUInt32 offset, AiUInt8 *srec, AiUInt8 *st, AiUInt32 *fsize );
Driver Command:
API_LOAD_SREC (0x36)
Purpose:
This function is used to download strings in S-Record format to the AIM board target.
The S-Record ASCII characters are converted into an executable format.
Note: this function is not supported for all boards. Please see Table B-III – Function
Support By Boards With ASP for details
Input
A
A
i
i
U
U
I
I
n
n
t
t
8
8
m
m
o
o
d
d
e
e
Value
Constant
Description
0
API_SREC_INIT
Initialize Download function (reset ‘fsize’)
1
API_SREC_DOWNLOAD
Download ‘cnt’ S-Record characters
2
API_SREC_START
Start downloaded program from ‘offset’ address
3
API_SREC_START_ONCE
Start downloaded program from ‘offset’ address
(non cyclic, that means once)
A
A
i
i
U
U
I
I
n
n
t
t
8
8
c
c
n
n
t
t
'mode'
Value
0
0
1
Amount of characters to download
2
0
A
A
i
i
U
U
I
I
n
n
t
t
3
3
2
2
o
o
f
f
f
f
s
s
e
e
t
t
'mode'
Value
0
0
1
Add Offset value to S-Record address
2
Address to start downloaded program from
A
A
i
i
U
U
I
I
n
n
t
t
8
8
*
*
s
s
r
r
e
e
c
c
Array of characters / Line from S-Record file
Output
A
A
i
i
U
U
I
I
n
n
t
t
8
8
*
*
s
s
t
t
Checksum status
Value
Value
Description
0
API_SREC_CHKS_OK
Checksum ok
1
API_SREC_ERR_NO_STRING
no S-Record string
2
API_SREC_ERR_WRONG_TYPE
wrong S-Record type
3
API_SREC_ERR_CHKS
Checksum error
4
API_SREC_ERR_ADDR
Addressing error
A
A
i
i
U
U
I
I
n
n
t
t
3
3
2
2
*
*
f
f
s
s
i
i
z
z
e
e