The C Code generates its own data types for use in the C Code functions. The C Code functions used these types to be more specific in the type of data they are using. For instance, instead of simply taking parameters of the ANSI C int, a C Code function may take parameters of the C Code data types Byte or Bool. Though these two types are equivalent to int, they serve to clarify the intent of functions that use them.
ANSI C data types are shown in blue. C Code generated data types are shown in plum.
Simple Types
The C Code creates the simple data types using the ANSI C typedef operator. Some of the C Code simple data types are based on other C Code simple data types.
Enumerated Types
The C Code creates enumerated types using ANSI C enum type.
| VortexClockDivisor | VortexClockDivisor_PreScale
VortexClockDivisor_Clock0 VortexClockDivisor_Clock1 VortexClockDivisor_Clock2 VortexClockDivisor_Clock3 VortexClockDivisor_Chop1 VortexClockDivisor_Chop2 |
Specifies OkikaVortex clock divisors for use in the C Code API ClockFunctions. |
| ApexClockDivisor | ApexClockDivisor_ClockSys1Sys2Flag
ApexClockDivisor_ClockSys2 ApexClockDivisor_ClockSys1 ApexClockDivisor_ClockPowerUps ApexClockDivisor_Clock0 ApexClockDivisor_Clock1 ApexClockDivisor_Clock2 ApexClockDivisor_Clock3 ApexClockDivisor_Clock4DelayClock4 ApexClockDivisor_Clock5 ApexClockDivisor_Clock5DelayClock5 |
Specifies OkikaApex clock divisors for use in the C Code API ClockFunctions. |
| VortexControlByte | an_VortexControlByte_SAFD
an_VortexControlByte_ResetAll an_VortexControlByte_InhibitRdbck an_VortexControlByte_Read an_VortexControlByte_SReset an_VortexControlByte_EndExecute an_VortexControlByte_TESTCTRL an_VortexControlByte_Pullups |
Flags that are available to turn on and off in the OkikaVortex reconfiguration control byte |
| ApexControlByte | an_ApexControlByte_EndExecute
an_ApexControlByte_Pullups an_ApexControlByte_ResetAll an_ApexControlByte_SAFD an_ApexControlByte_UpdateClocks an_ApexControlByte_SReset |
Flags that are available to turn on and off in the OkikaApex reconfiguration control byte |
Note: The chopper clock divisor consists of two bytes. One of the bytes is referred to here as "ClockDivisor_Chop1" and the other is referred to as "ClockDivisor_Chop2".