Aim MIL-STD-1553 - Function Call Documentation Conventions; Figure 1.3.3-1 - Document Conventions

MIL-STD-1553 Reference Manual
5
Chapter 1 - Introduction
1.3.3 Function Call Documentation Conventions
Each function call contained in this document uses a standard documentation format.
The information included for each function call is as follows:
Figure 1.3.3-1 – Document Conventions
Prototype:
return value data type function name (function parameter(s));
Driver Command:
Constant Definition (value)
Purpose:
Purpose of the function
I
I
n
n
p
p
u
u
t
t
l
l
i
i
s
s
t
t
o
o
f
f
i
i
n
n
p
p
u
u
t
t
s
s
O
O
u
u
t
t
p
p
u
u
t
t
l
l
i
i
s
s
t
t
o
o
f
f
o
o
u
u
t
t
p
p
u
u
t
t
s
s
Return Value
r
r
e
e
t
t
u
u
r
r
n
n
v
v
a
a
l
l
u
u
e
e
Data type of the return
value. Will show
"Void" if there is no
return value
Specifies the hex code
for the driver
command used by the
target s/w to
accomplish the action
required by the
function. See Section
13 for a complete list.
Specifies the inputs to
the function. All
possible input values
are detailed.
Outputs are provided via
an address specified as an
input parameter. The
structure and content of
the information output to
that address location is
specified here.
The value returned via the
function is a status/error code
defining the success/failure of
the function call. The
status/error code value is
detailed here.
Specifies the
parameters to be
passed to the
function, the function
name and the type of
the return value.