Maxim Integrated 73S12xxF Software - Manual (Page 3)

UG_12xxF_016
73S12xxF Software User Guide
Rev. 1.50 3
Table of Contents
1 Introduction ................................................................................................................................... 5
1.1 Acronyms ................................................................................................................................ 5
1.2 Use of this Document............................................................................................................... 6
1.3 Statement of Compliance ......................................................................................................... 6
2 Design Guide ................................................................................................................................. 7
2.1 Development Environment ...................................................................................................... 7
2.1.1 Hardware Requirements .............................................................................................. 7
2.1.2 Software Requirements ............................................................................................... 7
2.2 Software Build Environment ..................................................................................................... 8
2.2.1 Software Architecture .................................................................................................. 8
2.2.2 API/Library and Header Files ..................................................................................... 10
2.2.3 External Application ................................................................................................... 11
2.2.4 Embedded Application .............................................................................................. 11
2.2.5 Build Environment with the Serial Boot Loader .......................................................... 11
2.2.6 Build Environment with the USB DFU Boot Loader .................................................... 14
3 Testing Environment ................................................................................................................... 17
3.1 EMV Level I Compliant Testing .............................................................................................. 17
3.2 CCID Testing ......................................................................................................................... 17
3.2.1 USB Testing: Microsoft HCT/DTM, and USB Command Verifier ................................ 17
3.2.2 Serial Testing ............................................................................................................ 18
4 Design Reference ........................................................................................................................ 19
4.1 Memory Map .......................................................................................................................... 19
4.1.1 Program Memory ....................................................................................................... 19
4.1.2 External Data Memory ............................................................................................... 20
4.1.3 Internal Data Memory ................................................................................................ 20
4.2 Low-level API ......................................................................................................................... 20
4.2.1 Keyboard Driver API – Available with all 73S12xxF Devices ....................................... 21
4.2.2 LCD Driver API – Available with all 73S12xxF Devices .............................................. 23
4.2.3 LED Driver API – Available with all 73S12xxF Devices............................................... 24
4.2.4 Real Time Clock API - Available with the 68-pin 73S12xxF ....................................... 26
4.2.5 Smart Card Interface Driver API – Available with all 73S12xxF Devices ..................... 30
4.2.6 SERIAL (RS232) Driver API – Available with all 73S12xxF Devices ........................... 39
4.2.7 USB API – Available with 64K Flash version of the 73S12xxF ................................... 42
4.2.8 Clock Generator Circuit API – Available with all 73S12xxF Devices ........................... 51
4.2.9 Power Management API – Available with all 73S12xxF Devices ................................ 52
4.2.10 Analog Threshold Management Driver API – Available with all 73S12xxF Devices ..... 53
4.2.11 Event Management API – Available with all 73S12xxF Devices ................................. 55
4.2.12 Timers API – Available with all 73S12xxF Devices ..................................................... 57
4.2.13 User IO API – Available with all 73S12xxF Devices ................................................... 58
4.2.14 External Interrupts API – Available with all 73S12xxF Devices ................................... 60
4.2.15 Special Function Register API – Available with all 73S12xxF Devices ........................ 61
4.2.16 Flash/Memory API – Available with all 73S12xxF Devices.......................................... 63
4.2.17 Boot Loader and Passcode Management – Available with the LAPI-*BL.lib Only ....... 67
4.2.18 Security Mode Management - Available with the LAPI-*BL.lib Only ........................... 69
4.2.19 Other Miscellaneous API Calls – Available with all 73S12xxF Devices ....................... 71
4.3 High-Level API ....................................................................................................................... 72
4.3.1 Smart Card Control ................................................................................................... 72
4.4 Flash Programming ............................................................................................................... 85