|
|
| PM5358 |
|
|
| Appendix A: Coding Conventions |
|
|
|
|
| Table 44: File Naming Conventions |
| |
|
|
|
|
| API (Module and | suni4x622_api.c | Generic driver API block, contains Module & |
| Device |
| Device Management API such as installing/de- |
| Management) |
| 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 | suni4x622_intf.c | Interface configuration functions for connecting |
| Configuration) |
| the device to external interfaces (i.e., PHY, PL3, |
|
|
| UL2, SBI, Telecombus, clk/data, LVDS, etc.) |
|
|
|
|
| API (Status and | suni4x622_stats.c | Data collection block for all device |
| counts) |
| results/counts not monitored through interrupt |
|
|
| processing. |
|
|
|
|
| API (Device | suni4x622_aps.c, | Device specific configuration functions defined |
| specific blocks) | suni4x622_loh.c, | in the driver architecture. |
|
| suni4x622_poh.c, |
|
|
| suni4x622_pyld.c, |
|
|
| suni4x622_soh.c |
|
|
|
|
|
| Hardware | suni4x622_hw.c, | Hardware specific functions, constants and |
| Dependent | suni4x622_hw.h | macros |
|
|
|
|
| RTOS Dependent | suni4x622_rtos.c, | RTOS specific functions, constants and macros |
|
| suni4x622_rtos.h |
|
|
|
|
|
| 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 |
|
|
| the driver |
|
|
|
|
| Header file | suni4x622_strs.h | Structures definitions |
|
|
|
|
Proprietary and Confidential to | 124 |
Document ID: |
|