PM5365 PMC-Sierra, Inc., PM5365 Datasheet - Page 93

• Manufacturer Part Number: PM5365
• Description: TEMUX/TEMAP/TECT3 T1/E1 FRAMER, VT/TU MAPPER, M12/M13 MUX DRIVER MANUAL
• Manufacturer: PMC-Sierra, Inc.

Proprietary and Confidential to PMC-Sierra, Inc., and for its Customers’ Internal Use
Document ID: PMC-1991611, Issue 2
Naming Conventions
Table 35 presents a summary of the naming conventions followed by PMC driver software. A
detailed description is then given in the following sub-sections.
The names used in the drivers are verbose enough to make their purpose fairly clear. This makes
the code more readable. Generally, the device’s name or abbreviation appears in prefix.
Table 35: Naming Conventions
Macros
The following list identifies the macro conventions used in the driver code:
·
·
Type
Macros
Constants
Structures
API Functions
Porting Functions
Other Functions
Variables
Pointers to variables Hungarian
Global variables
Macro names must be all uppercase.
Words shall be separated by an underscore.
Case
Uppercase
Uppercase
Hungarian
Notation
Hungarian
Notation
Hungarian
Notation
Hungarian
Notation
Hungarian
Notation
Notation
Hungarian
Notation
TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual
Naming convention
prefix with
abbreviation
prefix with device abbreviation
prefix with
abbreviation
prefix with device name
prefix with
name
prefix variable name with
prefix with device name
“m”
“s”
“sys”
and device
and device
and device
“p”
Appendix A: Coding Conventions
Examples
mTMX_WRITE
TMX_REG
sTMX_DDB
temuxAdd()
sysTemuxReadReg()
myOwnFunction()
maxDevs
pmaxDevs
temuxMDB
93