PMC-Sierra PM5358 S/UNI 4x622 Power Screwdriver User Manual


 
PM5358 S/UNI-4x622 Driver Manual
Appendix A: Coding Conventions
Proprietary and Confidential to PMC-Sierra, Inc. 124
Document ID: PMC-2010419, Issue 1
Table 44: File Naming Conventions
API (Module and
Device
Management)
suni4x622_api.c
Generic driver API block, contains Module &
Device Management API such as installing/de-
installing driver instances, read/writes, and
initialization profiles.
API (ISR)
suni4x622_isr.c
Interrupt processing is handled by this block.
This includes both ISR and DPR management
API (Diagnostics)
suni4x622_diag.c
Device diagnostic functions
API (Interface
Configuration)
suni4x622_intf.c
Interface configuration functions for connecting
the device to external interfaces (i.e., PHY, PL3,
UL2, SBI, Telecombus, clk/data, LVDS, etc.)
API (Status and
counts)
suni4x622_stats.c
Data collection block for all device
results/counts not monitored through interrupt
processing.
API (Device
specific blocks)
suni4x622_aps.c,
suni4x622_loh.c,
suni4x622_poh.c,
suni4x622_pyld.c,
suni4x622_soh.c
Device specific configuration functions defined
in the driver architecture.
Hardware
Dependent
suni4x622_hw.c,
suni4x622_hw.h
Hardware specific functions, constants and
macros
RTOS Dependent
suni4x622_rtos.c,
suni4x622_rtos.h
RTOS specific functions, constants and macros
Other
suni4x622_util.c
Utility functions
Header file
suni4x622_api.h
Prototypes for all the API functions of the driver
Header file
suni4x622_err.h
Return codes
Header file
suni4x622_defs.h
Constants and macros, registers and bitmaps,
enumerated types
Header file
suni4x622_typs.h
Standard types definition (i.e., UINT1, UINT2,
etc.)
Header file
suni4x622_fns.h
Prototypes for all the non-API functions used in
the driver
Header file
suni4x622_strs.h
Structures definitions