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

• 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
·
·
Constants
The following list identifies the constants conventions used in the driver code:
·
·
·
·
Structures
The following list identifies the structures conventions used in the driver code:
·
·
·
·
Functions
API Functions
Naming of the API functions must follow the Hungarian notation.
·
·
Porting Functions
Porting functions correspond to functions that are hardware and/or RTOS dependant.
·
·
·
·
The letter
abbreviation must appear.
Example:
Constant names must be all uppercase.
Words shall be separated by an underscore.
The device abbreviation must appear as a prefix.
Example:
Structure names must be all uppercase.
Words shall be separated by an underscore.
The letter
device abbreviation must appear.
Example:
The device’s full name in all lowercase shall be used as a prefix.
Example:
Naming of the porting functions must follow the Hungarian notation.
The
The device’s name starting with an uppercase must follow the prefix.
Example:
“sys”
mTEMUX_WRITE
TEMUX_ERR_ARG
sTMX_DDB
temuxAdd()
sysTemuxReadReg()
“m”
“s”
prefix shall be used to indicate a porting function.
in lowercase is used as a prefix to specify that it is a macro, then the device
in lowercase must be used as a prefix to specify that it is a structure, then the
is a valid name for a structure.
is a valid name for an API function.
is a valid name for a macro.
is a valid name for a constant.
TEMUX/TEMAP/TECT3 (PM8315, PM5365, PM4328) Driver Manual
is a hardware/RTOS specific.
Appendix A: Coding Conventions
94