| Copyright © 2000-2002 ARM Limited. All rights reserved. | ARM DUI 0136D |
| Non-Confidential | |
 PDF version | |
| Home > An Introduction to µHAL > About µHAL > µHAL naming conventions |
| |||
| Home > An Introduction to µHAL > About µHAL > µHAL naming conventions | |||
Every µHAL routine has the following naming conventions:
the prefix uHAL
the object type
underscore
a meaningful capitalized name.
Table 2.1 lists these conventions by object type.
Table 2.1. µHAL naming conventions
| Object type | Sample |
|---|---|
| Basic routine, part of the API | uHALr_GlobalRoutine |
| Extended routine, part of the API | uHALir_InternalRoutine |
| Global variable, part of the exported API | uHALv_GlobalVariable |
| Internal variable, not part of the exported API | uHALiv_InternalVariable |
| Pointer | uHALp_PointerVariable |
| Internal pointer | uHALip_InternalPointer |
| Global structure, part of the exported API | uHALs_GlobalStructure |
| Global enumerated variable | uHALe_GlobalEnum |
The extended routines provide access to lower-levels of the library functionality. You must have an understanding of how µHAL operates internally before you use the extended routines.
| Copyright © 2000-2002 ARM Limited. All rights reserved. | ARM DUI 0136D |
| Non-Confidential | |
| PDF version | |
| Home > An Introduction to µHAL > About µHAL > µHAL naming conventions |