Building An Application; Type Definitions; Naming - Silicon Laboratories Si4010 Software Programming Manual

AN370

4. Building an Application

4.1. Type Definitions

The following table lists types that are defined or expected for use with the Si4010 API. The custom types are
defined in the header file
unsigned char
unsigned int
unsigned long int
signed char
All variables are stored in big endian fashion, which means that the most significant byte is stored on the lowest
(smallest) address location.

4.2. Naming

Strict naming conventions are used for the API. Each function belonging to the same software module is prefixed
by the module name or module name abbreviation. Before the module name, the function name is prefixed by the
type of the return value.
All variables are prefixed by their type. Defined types, pointers, input and output variables, and pointers to input/
output function variables are also prefixed accordingly. In addition to the prefixes for the basic types in the table in
section 4.1, the following prefixes are used. The dot in the prefix specification means that the letter cannot stand on
its own and must be preceded or succeeded by another prefix letter or letters:
Prefix
t
r
p.
v
.i
..o
..io
8
si4010_types.h .
Type Bit Width
int
long int
float
Description
Type definition of a structure
Structure variable definition
Pointer to
Void
Input function variable
Output function variable. Make sense if used
as a pointer to output. The pointed content is
generated by the function.
Input/output function variables. Make sense
if used as a pointer. The pointed content is
used as input and modified by a function.
Type Definition
8 BYTE
16 WORD
32 LWORD
8 CHAR
16
32
32
Rev. 1.0
Prefix
b
w
l
c
i
j
f
Example
tBsr_Setup
rSetup
prSetup
vBsr_Setup()
biTstCtrl
*pboOutput
*pbioState