Naming Conventions
1-10
1.3.2 Object Names
System objects included in the configuration by default typically have names
beginning with a 3- or 4-letter code for the module that defines or uses the
object. For example, the default configuration includes a LOG object called
LOG_system.
Note:
Objects you create statically should use a common naming convention of
your choosing. You might want to use the module name as a suffix in object
names. For example, a TSK object that encodes data might be called
encoderTsk.
1.3.3 Operation Names
The format for a DSP/BIOS API operation name is MOD_action where MOD
is the letter code for the module that contains the operation, and action is the
action performed by the operation. For example, the SWI_post function is
defined by the SWI module; it posts a software interrupt.
This implementation of the DSP/BIOS API also includes several built-in
functions that are run by various built-in objects. Here are some examples:
❏ CLK_F_isr. Run by an HWI object to provide the low-resolution CLK tick.
❏ PRD_F_tick. Run by the PRD_clock CLK object to manage PRD_SWI
and system tick.
❏ PRD_F_swi. Triggered by PRD_tick to run the PRD functions.
❏ _KNL_run. Run by the lowest priority SWI object, KNL_swi, to run the
task scheduler if it is enabled. This is a C function called KNL_run. An
underscore is used as a prefix because the function is called from
assembly code.
❏ _IDL_loop. Run by the lowest priority TSK object, TSK_idle, to run the
IDL functions.
❏ IDL_F_busy. Run by the IDL_cpuLoad IDL object to compute the current
CPU load.
❏ RTA_F_dispatch. Run by the RTA_dispatcher IDL object to gather real-
time analysis data.
❏ LNK_F_dataPump. Run by the LNK_dataPump IDL object to manage
the transfer of real-time analysis and HST channel data to the host.
❏ HWI_unused. Not actually a function name. This string is used in the
configuration to mark unused HWI objects.
To Next Page
Loading...
Need help?
General
