Aim MIL-STD-1553 - Conventions Used; General Documentation Conventions; Naming Conventions

MIL-STD-1553 Reference Manual
3
Chapter 1 - Introduction
1.3 Conventions Used
1.3.1 General Documentation Conventions
We use a number of different styles of text and layout in this document to help differentiate
between the different kinds of information. Here are some examples of the styles we use and an
explanation of what they mean:
Italics - used as a placeholder for the actual name, filename, or version of the software in use
Bold text - a function, or parameter, or used to highlight important information
Bold italics - caution, warning or note
Font - font used to show paths, directories and filenames within the body of text will be shown
in blue, for example:
C:\Windows\System32\Drivers\Aim_mil.sys
A smaller version of this font will be used to list
software code.
In addition to text and layout convention, there are a couple of naming conventions used to
simplify the information herein. All AIM hardware systems/cards utilize the same s/w library
functions also called the Application Program Interface (API). Therefore, for ease of
documentation flow, this s/w library will be referred to from this point on as the API S/W
Library. In addition, the software and firmware contained on the AIM bus interface 1553
device will be referred to as the Target S/W. Several references will be made within the API
S/W Library function description to the Application Interface. The Application Interface is the
software interface between the API S/W Library function calls and the Target S/W.
1.3.2 Naming Conventions
Naming conventions have been used for naming constants, structures, functions calls and data
types throughout the API S/W Library. All constants, structures and functions used in the API
S/W Library are defined in the Ai1553i_def.h header file which is contained in Appendix B.
Data types used in the API S/W Library are defined in ai_cdef.h, also defined in Appendix B.
Naming conventions used include the following
 Constants - For every function call, a list of constants have been defined to better
describe the numerical value of the function input or output (located in Ai1553i_def.h)
 Structures - Named as ty_api_name where name is unique to the structure (located in
Ai1553i_def.h)
 Functions - Named as either Apiname or ApiCmdname -
Apiname functions do not involve driver commands to the biu
ApiCmdname functions involve driver commands to the biu