This reference shows all C Code functions and types as they would be generated without the default prefix of "an_". For more information on the prefix, see the Generation Options – Generate C Code Window.
ANSI C data types are shown in blue. C Code generated data types are shown in plum. For more information, see Data Types.
Important: Some of the functions are for OkikaVortex chips and some are for OkikaApex chips. Please use functions that are appropriate for the particular chip(s) you are using.
Primary Configuration
| GetVortexPrimaryConfigData
GetApexPrimaryConfigData |
Gets the configuration data required to perform a primary configuration. |
| GetResetData | Gets the configuration data required to perform a soft reset. |
Reconfiguration
| InitializeVortexReconfigData
InitializeApexReconfigData |
Prepares the data buffer that will hold the reconfiguration data. |
| ShutdownVortexReconfigData
ShutdownApexReconfigData |
Destroys the reconfiguration data buffer created by InitializeReconfigData. |
| ClearVortexReconfigData
ClearApexReconfigData |
Clears the data buffer that holds the reconfiguration data for the chip without deallocating memory. |
| GetVortexReconfigData GetApexReconfigData | Gets the current reconfiguration data. |
| GetVortexReconfigControlFlags GetApexReconfigControlFlags | Gets the control byte of the reconfiguration data |
| SetVortexReconfigControlFlags SetApexReconfigControlFlags | Sets the control bytes of the reconfiguration data. |
Power Management
| GetVortexSleepData
GetApexSleepData |
Gets the configuration data required to put a chip into sleep mode. |
Clocks
| GetMasterClock | Gets the frequency in Hz of a chip’s master clock. |
| GetVortexClockDivisor GetApexClockDivisor | Gets the current value of a clock divisor. |
| SetVortexClockDivisor
SetApexClockDivisor |
Sets the value of a clock divisor. |
| IncrementVortexClockDivisor
IncrementApexClockDivisor |
Increments the current value of a clock divisor to the next valid divisor value. |
| DecrementVortexClockDivisor
DecrementApexClockDivisor |
Decrements the current value of a clock divisor to the next valid divisor value. |
| ClockUpdatesFinished | Called after sending a clock-updating reconfiguration. USE ONLY WITH OkikaVortex DynAMx’s |