Download Heron-API User Manual

Version Control
Version 1.0 – First version
Software v2.0 Major rewrite to remove design problems. Document rev. C refers.
Software v2.1 FIFO performance enhanced, two new functions. Document rev. D refers.
Software v2.2 Support added for dedicated DMA. Document rev. E refers.
Software v2.3 Some function names changed to match xDAIS guidelines (see section
Migrating from Previous Versions of the HERON-API). Changed FIFO Handle type to be
“HeronFIFO” to match xDAIS guidelines. New functions added:
HeronReadWord,HeronWriteWord, HeronCancelWithFlush, HeronInstallIsr,
HeronUmiOut, HeronUmiIn and HeronModId. Some functions made inline to increase
efficiency.
Software v2.4 FIFO performance enhanced. Functions HeronTestIo and HeronWaitIo
rewritten as inline functions. HeronRead and HeronWrite made partially inline. Functions
HeronRestartRead and HeronRestartWrite added.
Software v2.5 Supported added for the HERON4 module. HERON1 code also improved.
New function HeronSwiOpenFifo added.
Software v2.6 Correction made to the HERON4 FIFO addresses.
Software v2.7 UMI functions added for the HERON4. Some changes made to the way
functions are inlined. Corrected HeronWriteWord for the HERON1.
Software v3.0 Streaming I/O (SIO) added for both the HERON1 and HERON4. New
functions added: HeronSioOpenFifo, HeronSioClose, HeronSioRead, HeronSioWrite and
HeronSioReadAlign.
Software v3.1 HeronSerial Bus (HSB) functions added for the HERON1 and HERON4.
New functions added: HeronHsbOpen, HeronHsbClose, HeronHsbSendMessage,
HeronHsbReceiveMessage, HeronHsbStartSendMessage, HeronHsbSendMessageData,
HeronHsbEndOfSendMessage, HeronHsbStartReceiveMessage,
HeronHsbReceiveMessageData, and HeronHsbEndOfReceiveMessage.
Software v3.2 Dedicated DMA functions for HERON4 and HERON1 had bugs. These
have been fixed at this version.
Software v3.3 first version of HERON API to support HEART (HEPC9 like) carriers.
HEPC8 is now supported as a legacy carrier.
Documentation change to clarify use of DMA reload register
Software v3.9 added HeronHsbSendMessageEx function to account for latency between
EM2 connected HSBs on different boards.
3
HUNT ENGINEERING HERON-API USER MANUAL