
APIS - AcQ Platform Interface Software
Programmer’s Manual Version: 2.1
AcQuisition Technology bv
P.O. Box 627, 5340 AP
Oss, The Netherlands
Page 1 of 77
CONTENTS
1. INTRODUCTION ........................................................... 5
1.1. VALIDITY OF THE MANUAL ............................................. 5
1.2. PURPOSE ........................................................ 5
1.3. SCOPE .......................................................... 5
1.4. DEFINITIONS, ACRONYMS AND ABBREVIATIONS .............................. 5
1.5. NOTES CONCERNING THE NOMENCLATURE ................................ 6
1.6. OVERVIEW ........................................................ 6
2. PRODUCT OVERVIEW ...................................................... 7
2.1. INTRODUCTION ..................................................... 7
2.2. TECHNICAL OVERVIEW ............................................... 7
3. FUNCTIONAL DESCRIPTION .................................................. 9
3.1. APIS CONCEPT .................................................... 9
3.2. BLOCK DIAGRAM ................................................... 9
3.3. APIS APPLICATION PROGRAMMING INTERFACE ............................ 10
3.3.1. PLATFORM IDENTIFIER ........................................ 10
3.3.2. TYPE DEFINITIONS ........................................... 11
3.3.3. APIS ERROR CODES ......................................... 12
3.3.4. FUNCTION REFERENCES AND MACRO’S ............................ 13
3.3.5. MULTI-PLATFORM SUPPORT .................................... 14
3.4. APIS FUNCTIONS DEFINITIONS ........................................ 14
3.4.1. OPEN A HARDWARE PATH ..................................... 15
3.4.2. CLOSE A HARDWARE PATH ..................................... 16
3.4.3. SINGLE READ .............................................. 17
3.4.4. SINGLE WRITE .............................................. 17
3.4.5. BLOCK READ ............................................... 18
3.4.6. BLOCK WRITE .............................................. 18
3.4.7. FIFO READ ................................................ 19
3.4.8. FIFO WRITE ................................................ 19
3.4.9. INSTALL INTERRUPT SERVICE ROUTINE ............................ 20
3.4.10. REMOVE INTERRUPT SERVICE ROUTINE ........................... 20
3.4.11. WAIT FOR INTERRUPT ........................................ 21
3.4.12. TIMED WAIT FOR INTERRUPT ................................... 21
3.4.13. EXECUTE CRITICAL CODE ...................................... 22
3.4.14. DELAY .................................................... 22
3.4.15. CHECK VERSION ............................................ 23
3.5. ENDIAN ISSUES ................................................... 24
3.5.1. BIG ENDIAN VERSUS LITTLE ENDIAN PLATFORMS ..................... 24
3.5.2. M-MODULE CARRIER BOARDS ................................... 24
3.6. SOFTWARE DISTRIBUTION ............................................ 27
4. APIS PLATFORM SUPPORT EXAMPLE ......................................... 29
4.1. APPLICATION PROGRAMMING INTERFACE ................................. 29
4.2. APIS PLATFORM SUPPORT MODULES ................................... 29
4.3. TYPE DEFINITIONS AND STRUCTURES ................................... 30
4.4. FUNCTION REFERENCE .............................................. 31
Comentarios a estos manuales