> For the complete documentation index, see [llms.txt](https://sandbox-docs.verifone.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://sandbox-docs.verifone.com/adk-5.0-programmers-guide/readme/files/dir_44d926a17fc606d3c25449ba60427c63/dir_048f823fee1bfb22502a8732b9a001aa/sys_8h.md).

# sys.h

[Data Structures](#nested-classes) | [Macros](#define-members) | [Typedefs](#typedef-members) | [Enumerations](#enum-members) | [Functions](#func-members)

This graph shows which files directly or indirectly include this file:

![](/files/ZgGU1UFUspVgQVQD96A4)

[Go to the source code of this file.](/adk-5.0-programmers-guide/sys_8h_source.md)

|                 |                                     |
| --------------- | ----------------------------------- |
| Data Structures |                                     |
| struct          | [thread\_data](#structthread__data) |

|         |                                                                                                                                                                                                                |
| ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Macros  |                                                                                                                                                                                                                |
| #define | [CLA\_SYS](#af7805be6c0a1866a0810f2ffc5dfb2dc)   0x20                                                                                                                                                          |
|         | <p>Class for System commands. <a href="#af7805be6c0a1866a0810f2ffc5dfb2dc">More...</a><br></p>                                                                                                                 |
| #define | [INS\_SYS\_SYNC\_TURN\_ON](#aea810192a402df0a33faa882ea076bc8)   0x00                                                                                                                                          |
|         | <p>Turn On device. <a href="#aea810192a402df0a33faa882ea076bc8">More...</a><br></p>                                                                                                                            |
| #define | [INS\_SYS\_TURN\_OFF](#a88534d083ea20c7f0e05ede598f105d7)   0x01                                                                                                                                               |
|         | <p>Turn Off device. <a href="#a88534d083ea20c7f0e05ede598f105d7">More...</a><br></p>                                                                                                                           |
| #define | [INS\_SYS\_ABORT](#a9af1087d5ffa81a0f54d93d4c5235c51)   0x02                                                                                                                                                   |
|         | <p>Abort any command in progress. <a href="#a9af1087d5ffa81a0f54d93d4c5235c51">More...</a><br></p>                                                                                                             |
| #define | [INS\_SYS\_GET\_CONFIG](#a1e2d090241dfcf12bba5d2e45b3d5f33)   0x03                                                                                                                                             |
|         | <p>Get device configuration. <a href="#a1e2d090241dfcf12bba5d2e45b3d5f33">More...</a><br></p>                                                                                                                  |
| #define | [INS\_SYS\_GET\_STATUS](#a98553a2159921c6a4a5e84d933891b0c)   0x04                                                                                                                                             |
|         | <p>Get device status info. <a href="#a98553a2159921c6a4a5e84d933891b0c">More...</a><br></p>                                                                                                                    |
| #define | [INS\_SYS\_SELFTEST](#a2058048dd49ff37e7d14422cf5ffef74)   0x05                                                                                                                                                |
|         | <p>Perform device selftest. <a href="#a2058048dd49ff37e7d14422cf5ffef74">More...</a><br></p>                                                                                                                   |
| #define | [INS\_SYS\_LOCK\_PAYMENT](#abd188cb21d2bf805c92a77ddae86eb37)   0x06                                                                                                                                           |
|         | <p>Lock payment. <a href="#abd188cb21d2bf805c92a77ddae86eb37">More...</a><br></p>                                                                                                                              |
| #define | [INS\_SYS\_SET\_STATUS](#ac67f66838ed245959518c01ba263c077)   0x09                                                                                                                                             |
|         | <p>Set device status info. <a href="#ac67f66838ed245959518c01ba263c077">More...</a><br></p>                                                                                                                    |
| #define | [INS\_SYS\_AUTH](#ad96983ee0fea39cc2c2de536b01041e5)   0x11                                                                                                                                                    |
|         | <p>Request authentication of data. <a href="#ad96983ee0fea39cc2c2de536b01041e5">More...</a><br></p>                                                                                                            |
| #define | [INS\_SYS\_SET\_IDLE\_TEXT](#a4716584d8cc1ceb9913b81093b1eb0bb)   0x13                                                                                                                                         |
|         | <p>Set the text displayed in the idle sceen (replaces the welcome text if set) <a href="#a4716584d8cc1ceb9913b81093b1eb0bb">More...</a><br></p>                                                                |
| #define | [INS\_SYS\_SW\_UPLOAD\_START](#a3ed8b7fb7f077ce09888eeefd0e6ba30)   0x14                                                                                                                                       |
|         | <p>Start a software upload. <a href="#a3ed8b7fb7f077ce09888eeefd0e6ba30">More...</a><br></p>                                                                                                                   |
| #define | [INS\_SYS\_SW\_UPLOAD\_TRANSFER](#a586ae83176f7669aca82a81a762f6021)   0x15                                                                                                                                    |
|         | <p>Transfer record data for software upload. <a href="#a586ae83176f7669aca82a81a762f6021">More...</a><br></p>                                                                                                  |
| #define | [INS\_SYS\_SW\_UPLOAD\_FINALIZE](#aab035bdcfd31ec20cede910f2dd11be4)   0x16                                                                                                                                    |
|         | <p>Finalize a software upload. <a href="#aab035bdcfd31ec20cede910f2dd11be4">More...</a><br></p>                                                                                                                |
| #define | [INS\_SYS\_SHUTDOWN\_REBOOT\_SLEEP](#a3ab736555cafdb3b2edc7576a8fa090d)   0x17                                                                                                                                 |
|         | <p>Shutdown, reboot or set the terminal to sleep. <a href="#a3ab736555cafdb3b2edc7576a8fa090d">More...</a><br></p>                                                                                             |
| #define | [INS\_SYS\_MAC\_SHOW\_DESKTOP](#a556d381c46ef2c2e6a4839efb62286f7)   0x18                                                                                                                                      |
|         | <p>Show the MAC desktop. <a href="#a556d381c46ef2c2e6a4839efb62286f7">More...</a><br></p>                                                                                                                      |
| #define | [INS\_SYS\_SET\_PROPERTY](#af8dac5fd1f8896a26d7a7c5045470a56)   0x19                                                                                                                                           |
|         | <p>Serialized <a href="/pages/206oSORyEUo1p3LtTso3#a377307b06ac969f30af51e7cccf94dbb">sysSetPropertyInt()</a>/sysSetPropertyString() command. <a href="#af8dac5fd1f8896a26d7a7c5045470a56">More...</a><br></p> |
| #define | [INS\_SYS\_GET\_PROPERTY](#a1f14950b662d9c0e92ff8bc514e2cec7)   0x1A                                                                                                                                           |
|         | <p>Serialized <a href="/pages/206oSORyEUo1p3LtTso3#ab94a5b33000760afbee10e7fefd16355">sysGetPropertyInt()</a>/sysGetPropertyString() command. <a href="#a1f14950b662d9c0e92ff8bc514e2cec7">More...</a><br></p> |
| #define | [INS\_SYS\_INSTALL\_SPONSOR\_CERT](#a183b9d13fdd951745876c62e4e9f36cb)   0x1B                                                                                                                                  |
|         | <p>Check and Install Sponsor Cert. <a href="#a183b9d13fdd951745876c62e4e9f36cb">More...</a><br></p>                                                                                                            |
| #define | [INS\_SYS\_GET\_VERSION\_INFO](#ae6edcfe0f7e81b59e5716fe53053fd86)   0x1C                                                                                                                                      |
|         | <p>Get version info of SDI components. <a href="#ae6edcfe0f7e81b59e5716fe53053fd86">More...</a><br></p>                                                                                                        |
| #define | [INS\_SYS\_CHECK\_FOR\_UPDATE](#a5b39f9b83e478aae444085ed9965f7de)   0x1D                                                                                                                                      |
|         | <p>Check for updates. <a href="#a5b39f9b83e478aae444085ed9965f7de">More...</a><br></p>                                                                                                                         |
| #define | [INS\_SYS\_SW\_GET\_LAST\_INSTALL\_ERROR](#a3270a127f531045f7684ef1347020658)   0x1E                                                                                                                           |
|         | <p>Get last install error from secure installer and reset. <a href="#a3270a127f531045f7684ef1347020658">More...</a><br></p>                                                                                    |
| #define | [INS\_SYS\_EXT\_BUTTON](#ac05d62b099d61b2dc58ba436a2d83a64)   0x20                                                                                                                                             |
|         | <p>External button was pressed. <a href="#ac05d62b099d61b2dc58ba436a2d83a64">More...</a><br></p>                                                                                                               |
| #define | [INS\_SYS\_EPP\_ENABLE](#a5a3270374de9c98314ce16b41c1b2a87)   0x21                                                                                                                                             |
|         | <p>Enable/Disable EPP. <a href="#a5a3270374de9c98314ce16b41c1b2a87">More...</a><br></p>                                                                                                                        |
| #define | [INS\_SYS\_FACTORY\_RESET](#aadd77f7ec4c84183e9f11979d6cc14ef)   0x22                                                                                                                                          |
|         | <p>Factory Reset. <a href="#aadd77f7ec4c84183e9f11979d6cc14ef">More...</a><br></p>                                                                                                                             |
| #define | [INS\_SYS\_READ\_CERTIFICATE](#a52291f320dbd3b054203375b5bf368dd)   0x23                                                                                                                                       |
|         | <p>Read Certificate. <a href="#a52291f320dbd3b054203375b5bf368dd">More...</a><br></p>                                                                                                                          |
| #define | [INS\_SYS\_FORCE\_CURR\_ABBR](#afba0f2e965faeae316893bbfb1871746)   0x24                                                                                                                                       |
|         | <p>Force Currency Abbreviation. <a href="#afba0f2e965faeae316893bbfb1871746">More...</a><br></p>                                                                                                               |
| #define | [INS\_SYS\_STATISTIC\_COUNTERS](#a4c5cfffd6c0688eab9b0ef3f67bf196f)   0x25                                                                                                                                     |
|         | <p>Statistic Counters. <a href="#a4c5cfffd6c0688eab9b0ef3f67bf196f">More...</a><br></p>                                                                                                                        |
| #define | [INS\_SYS\_PUBLIC\_ICC\_RFID](#af73feab1ba2fc01c2069a6ff01041b81)   0x26                                                                                                                                       |
|         | <p>Enable/Disable public access to the ICC/RFID commands of secure processor. <a href="#af73feab1ba2fc01c2069a6ff01041b81">More...</a><br></p>                                                                 |
| #define | [MAX\_OUT\_MSG\_SIZE\_A](#a535a37cbfd7f58dd8f5dbdb69ababfd9)   0xFFF0                                                                                                                                          |
| #define | [MAX\_OUT\_MSG\_SIZE\_B\_C\_D](#a0a4d3755c2b2df8a7d65e91e847f3f0b)   0xFFFF                                                                                                                                    |
| #define | [MIN](#a3acffbd305ee72dcd4593c0d8af64a4f)(a, b)   ((a)<(b)?(a):(b))                                                                                                                                            |

|                                                    |                                                    |
| -------------------------------------------------- | -------------------------------------------------- |
| Typedefs                                           |                                                    |
| typedef struct [thread\_data](#structthread__data) | [Thread\_Data](#a180fda2fed413013609591e0b565b8e8) |

|              |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Enumerations |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| enum         | <p><a href="#a0ee277aec4317de742cf8b2bd40af3a9">ExtserverResult</a> {<br>  <a href="#a0ee277aec4317de742cf8b2bd40af3a9a818c541216b4ca0e29b7885495a46ad2">RESULT\_OK</a> = 0, <a href="#a0ee277aec4317de742cf8b2bd40af3a9adbaa15b6c3bcc0196b4b314fac50e36c">RESULT\_FAIL</a> = -1, <a href="#a0ee277aec4317de742cf8b2bd40af3a9ad02c8491b0eab6eab286a00466993805">RESULT\_TIMEOUT</a> = -2, <a href="#a0ee277aec4317de742cf8b2bd40af3a9ae9a95470ffa907b24be20927bd6b6524">RESULT\_USER\_CANCEL</a> = -3,<br>  <a href="#a0ee277aec4317de742cf8b2bd40af3a9ae0fc559eeb55b5d25b1e3dad4877f02a">RESULT\_MOBILE\_ABORT</a> = -4, <a href="#a0ee277aec4317de742cf8b2bd40af3a9abb0279cf3581b071df7f16d126c87477">RESULT\_NO\_LINK</a> = -5, <a href="#a0ee277aec4317de742cf8b2bd40af3a9ae3422d8a18a394540cab891cb3b59b78">RESULT\_CLEAR\_BUTTON</a> = -6, <a href="#a0ee277aec4317de742cf8b2bd40af3a9a54ebd26ad0cc26331ce3189908bc1866">RESULT\_DATA\_AVAILABLE</a> = -7,<br>  <a href="#a0ee277aec4317de742cf8b2bd40af3a9ab7791209b54a1f594110c871500ac7cc">RESULT\_EXCESSIVE\_PIN\_REQUESTS</a> = -8, <a href="#a0ee277aec4317de742cf8b2bd40af3a9a98a7e70df73757a57d668cea47b6e058">RESULT\_TAG\_ERROR</a> = -9, <a href="#a0ee277aec4317de742cf8b2bd40af3a9a9b341401cd6686c61d31b0ab76fd3ef1">RESULT\_TAG\_LENGTH\_ERROR</a> = -10, <a href="#a0ee277aec4317de742cf8b2bd40af3a9abdddee10f743a36a524e311669116326">RESULT\_PARAMETER\_ERROR</a> = -11,<br>  <a href="#a0ee277aec4317de742cf8b2bd40af3a9aeaabb76b9cc0decb0985ea5797440b88">RESULT\_INTERCHAR\_TIMEOUT</a> = -12, <a href="#a0ee277aec4317de742cf8b2bd40af3a9a112f04f754eb9b75ffc9852d4c0fb156">RESULT\_LOGIC\_ERROR</a> = -13<br>}</p>                                                                                                                                                   |
| enum         | <p><a href="#a6cd49ae0288c8ad7e57768049b88e2c0">UploadType</a> {<br>  <a href="#a6cd49ae0288c8ad7e57768049b88e2c0a7bf67041c45c44d425c383a7ebcdfe46">UPLOAD\_TYPE\_SOFTWARE\_UPDATE</a>, <a href="#a6cd49ae0288c8ad7e57768049b88e2c0a34f5269aab5031c2734b5adc6680497e">UPLOAD\_TYPE\_CONFIG\_WHITELIST</a>, <a href="#a6cd49ae0288c8ad7e57768049b88e2c0a2673e19024e6247e70a2af83476dde43">UPLOAD\_TYPE\_CONFIG\_SENSITIVE\_TAGS</a>, <a href="#a6cd49ae0288c8ad7e57768049b88e2c0a81fd3b513fd362d89e3aa7694b8da5ba">UPLOAD\_TYPE\_CONFIG\_CARD\_RANGES</a>,<br>  <a href="#a6cd49ae0288c8ad7e57768049b88e2c0a7ea1f2e7950b794e9cb1937237ad67af">UPLOAD\_TYPE\_FIRMWARE\_UPDATE</a>, <a href="#a6cd49ae0288c8ad7e57768049b88e2c0a45cf0bd2cd8c067e00540e4eeb5cf688">UPLOAD\_TYPE\_KEYS</a>, <a href="#a6cd49ae0288c8ad7e57768049b88e2c0a794564e38d5b307089756bf59d4cefa9">UPLOAD\_TYPE\_CONFIG\_SDIEMV</a>, <a href="#a6cd49ae0288c8ad7e57768049b88e2c0ac0b55fa237e2c9e6404a01ddaa64e114">UPLOAD\_TYPE\_REMOVE\_SPONSOR</a>,<br>  <a href="#a6cd49ae0288c8ad7e57768049b88e2c0a41e05b1531d19de605151972bfd31bec">UPLOAD\_TYPE\_REMOVE\_CONFIG\_SDIEMV</a>, <a href="#a6cd49ae0288c8ad7e57768049b88e2c0a0e250606f2be91f748221a82209ead8a">UPLOAD\_TYPE\_PLUGIN</a>, <a href="#a6cd49ae0288c8ad7e57768049b88e2c0affd345175d249f8c98f96e0ee0d19c17">UPLOAD\_TYPE\_REMOVE\_PLUGIN</a>, <a href="#a6cd49ae0288c8ad7e57768049b88e2c0a87320aad5379f54e7385ba48e735b3e2">UPLOAD\_TYPE\_CP\_PACKAGE</a>,<br>  <a href="#a6cd49ae0288c8ad7e57768049b88e2c0a538ea2e0f3f71bc276c0d87787edf922">UPLOAD\_TYPE\_EMV\_CONFIG\_PACKAGE</a>, <a href="#a6cd49ae0288c8ad7e57768049b88e2c0a90968c682bc475511600bccf72633511">UPLOAD\_TYPE\_UVRK\_PACKAGE</a>, <a href="#a6cd49ae0288c8ad7e57768049b88e2c0a51246b9edc5cc59323c993619584e692">UPLOAD\_TYPE\_MAX</a><br>}</p> |
| enum         | [IdleScreenMode](#acdffce6b62c4db2a50dd9cdae6caba78) { [Idle\_Normal](#acdffce6b62c4db2a50dd9cdae6caba78abe85fe1a66041bcdd883413a79606363) = 0, [Idle\_MenuEnabled](#acdffce6b62c4db2a50dd9cdae6caba78a18fc0e990d0fa8795a191a2a03b9ef64) = 1, [Idle\_WaitLogo](#acdffce6b62c4db2a50dd9cdae6caba78a6bc06fe4ebc2a6b6d3e76ea084f42710) = 2, [Idle\_NoAdminMode](#acdffce6b62c4db2a50dd9cdae6caba78a2ddddb450f003d9d854201353a3cd4b6) = 4 }                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| enum         | [IdleLockType](#acbca865bf1cc550151c765b4bb11dc7e) { [ILT\_NoLock](#acbca865bf1cc550151c765b4bb11dc7ea78d433f6f876bbc24a90dbccae665624) = 0, [ILT\_ApiLock](#acbca865bf1cc550151c765b4bb11dc7ea952eed5112fd85859a0bd8ecd62b9647) = 1, [ILT\_AdminLock](#acbca865bf1cc550151c765b4bb11dc7ea0af1ff86e1129d6f7f9ad06a68a7b104) = 2 }                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |

|                                                         |                                                                                                                                                                                                        |
| ------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Functions                                               |                                                                                                                                                                                                        |
| bool                                                    | [handleSystemCmd](#afe8ab8c8d592d69c0b6d074f03081d3e) (unsigned long msgBufSize, unsigned char \*msg, unsigned long msgSize, unsigned short rspBufSize, unsigned char \*rsp, unsigned short \*rspSize) |
| int                                                     | [check4Interrupt](#af8ff9f4a2125f866eda540eaf867197b) (void)                                                                                                                                           |
| void                                                    | [setInterrupt](#a86502db8f28fe31f7ee0266a97ee156a) (enum [ExtserverResult](#a0ee277aec4317de742cf8b2bd40af3a9) reason)                                                                                 |
| int                                                     | [isCardRemoved](#a43801947261b861981e5f2c52e878fa0) (void)                                                                                                                                             |
| const char \*                                           | [errText](#ae05a33a2f7e55688d36a0692fc795ffe) (int err)                                                                                                                                                |
| void                                                    | [setDevice2Idle](#ac28a8edfbaded7c71c0e249ae70aba3b) (void)                                                                                                                                            |
| void                                                    | [sysDisplayIdleScreen](#ad2bc24707c477aa4c2cb1c4fb92855df) (unsigned mode=[Idle\_Normal](#acdffce6b62c4db2a50dd9cdae6caba78abe85fe1a66041bcdd883413a79606363), const char \*idletext=0)                |
| bool                                                    | [sysSetIdleScreenFinished](#a02ab2d39fc437b5924aed122a8adb57e) (unsigned long id)                                                                                                                      |
| void                                                    | [sysSetIdleScreenAdminMenu](#af85581548b99a07d923feb33e0297b5c) (bool on)                                                                                                                              |
| bool                                                    | [sysSetIdleScreenLocked](#af0f2a2ccba88c6c9f0ee759172febaa0) (bool lock=true, bool update\_screen=true)                                                                                                |
| enum [IdleLockType](#acbca865bf1cc550151c765b4bb11dc7e) | [sysGetIdleScreenLocked](#af826b34d72f2718baf08d472448063bd) ()                                                                                                                                        |
| void                                                    | [setSW1SW2](#a2b1e62cbba20fe441f74365bab09c22c) (int result, unsigned char \*rsp)                                                                                                                      |
| bool                                                    | [sys\_internal\_android](#a914eb0ad5b455073caeed46e742f3cd2) ()                                                                                                                                        |
| bool                                                    | [vos\_sys8](#a7109ff8195a9046828f8120509022d76) ()                                                                                                                                                     |
| bool                                                    | [checkBundleInstalled](#a3aeb676c0c19ca74396503eb1267f979) (const char \*bdlname)                                                                                                                      |
| bool                                                    | [isHwModelName](#aadbe3a6553fce242b52a2655173897fe) (const char \*targetHwModelName)                                                                                                                   |
| void                                                    | [sysResetUpdateContext](#a6777013b116ca3f41fc511143671ef8e) (void \*handle)                                                                                                                            |
| bool                                                    | [isUX412](#a238f9de29efff641b730a71ee5bc4bbb) ()                                                                                                                                                       |
| bool                                                    | [isUX302](#a0e3f2c6c7758e8f0e2c1246d5d34862b) ()                                                                                                                                                       |

***

### DataStructure Documentation <a href="#data-structure-documentation" id="data-structure-documentation"></a>

### thread\_data <a href="#structthread__data" id="structthread__data"></a>

struct thread\_data

|               |               |   |
| ------------- | ------------- | - |
| Data Fields   |               |   |
| void \*       | addThreadData |   |
| char \*       | cmdData       |   |
| unsigned long | cmdSize       |   |
| int           | taskId        |   |

### MacroDefinition Documentation <a href="#macro-definition-documentation" id="macro-definition-documentation"></a>

### CLA\_SYS <a href="#af7805be6c0a1866a0810f2ffc5dfb2dc" id="af7805be6c0a1866a0810f2ffc5dfb2dc"></a>

\#define CLA\_SYS   0x20

Class for System commands.

### INS\_SYS\_ABORT <a href="#a9af1087d5ffa81a0f54d93d4c5235c51" id="a9af1087d5ffa81a0f54d93d4c5235c51"></a>

\#define INS\_SYS\_ABORT   0x02

Abort any command in progress.

### INS\_SYS\_AUTH <a href="#ad96983ee0fea39cc2c2de536b01041e5" id="ad96983ee0fea39cc2c2de536b01041e5"></a>

\#define INS\_SYS\_AUTH   0x11

Request authentication of data.

### INS\_SYS\_CHECK\_FOR\_UPDATE <a href="#a5b39f9b83e478aae444085ed9965f7de" id="a5b39f9b83e478aae444085ed9965f7de"></a>

\#define INS\_SYS\_CHECK\_FOR\_UPDATE   0x1D

Check for updates.

### INS\_SYS\_EPP\_ENABLE <a href="#a5a3270374de9c98314ce16b41c1b2a87" id="a5a3270374de9c98314ce16b41c1b2a87"></a>

\#define INS\_SYS\_EPP\_ENABLE   0x21

Enable/Disable EPP.

### INS\_SYS\_EXT\_BUTTON <a href="#ac05d62b099d61b2dc58ba436a2d83a64" id="ac05d62b099d61b2dc58ba436a2d83a64"></a>

\#define INS\_SYS\_EXT\_BUTTON   0x20

External button was pressed.

### INS\_SYS\_FACTORY\_RESET <a href="#aadd77f7ec4c84183e9f11979d6cc14ef" id="aadd77f7ec4c84183e9f11979d6cc14ef"></a>

\#define INS\_SYS\_FACTORY\_RESET   0x22

Factory Reset.

### INS\_SYS\_FORCE\_CURR\_ABBR <a href="#afba0f2e965faeae316893bbfb1871746" id="afba0f2e965faeae316893bbfb1871746"></a>

\#define INS\_SYS\_FORCE\_CURR\_ABBR   0x24

Force Currency Abbreviation.

### INS\_SYS\_GET\_CONFIG <a href="#a1e2d090241dfcf12bba5d2e45b3d5f33" id="a1e2d090241dfcf12bba5d2e45b3d5f33"></a>

\#define INS\_SYS\_GET\_CONFIG   0x03

Get device configuration.

### INS\_SYS\_GET\_PROPERTY <a href="#a1f14950b662d9c0e92ff8bc514e2cec7" id="a1f14950b662d9c0e92ff8bc514e2cec7"></a>

\#define INS\_SYS\_GET\_PROPERTY   0x1A

Serialized [sysGetPropertyInt()](/adk-5.0-programmers-guide/readme/modules/group__led/namespacevfisysinfo.md#ab94a5b33000760afbee10e7fefd16355)/sysGetPropertyString() command.

### INS\_SYS\_GET\_STATUS <a href="#a98553a2159921c6a4a5e84d933891b0c" id="a98553a2159921c6a4a5e84d933891b0c"></a>

\#define INS\_SYS\_GET\_STATUS   0x04

Get device status info.

### INS\_SYS\_GET\_VERSION\_INFO <a href="#ae6edcfe0f7e81b59e5716fe53053fd86" id="ae6edcfe0f7e81b59e5716fe53053fd86"></a>

\#define INS\_SYS\_GET\_VERSION\_INFO   0x1C

Get version info of SDI components.

### INS\_SYS\_INSTALL\_SPONSOR\_CERT <a href="#a183b9d13fdd951745876c62e4e9f36cb" id="a183b9d13fdd951745876c62e4e9f36cb"></a>

\#define INS\_SYS\_INSTALL\_SPONSOR\_CERT   0x1B

Check and Install Sponsor Cert.

### INS\_SYS\_LOCK\_PAYMENT <a href="#abd188cb21d2bf805c92a77ddae86eb37" id="abd188cb21d2bf805c92a77ddae86eb37"></a>

\#define INS\_SYS\_LOCK\_PAYMENT   0x06

Lock payment.

### INS\_SYS\_MAC\_SHOW\_DESKTOP <a href="#a556d381c46ef2c2e6a4839efb62286f7" id="a556d381c46ef2c2e6a4839efb62286f7"></a>

\#define INS\_SYS\_MAC\_SHOW\_DESKTOP   0x18

Show the MAC desktop.

### INS\_SYS\_PUBLIC\_ICC\_RFID <a href="#af73feab1ba2fc01c2069a6ff01041b81" id="af73feab1ba2fc01c2069a6ff01041b81"></a>

\#define INS\_SYS\_PUBLIC\_ICC\_RFID   0x26

Enable/Disable public access to the ICC/RFID commands of secure processor.

### INS\_SYS\_READ\_CERTIFICATE <a href="#a52291f320dbd3b054203375b5bf368dd" id="a52291f320dbd3b054203375b5bf368dd"></a>

\#define INS\_SYS\_READ\_CERTIFICATE   0x23

Read Certificate.

### INS\_SYS\_SELFTEST <a href="#a2058048dd49ff37e7d14422cf5ffef74" id="a2058048dd49ff37e7d14422cf5ffef74"></a>

\#define INS\_SYS\_SELFTEST   0x05

Perform device selftest.

### INS\_SYS\_SET\_IDLE\_TEXT <a href="#a4716584d8cc1ceb9913b81093b1eb0bb" id="a4716584d8cc1ceb9913b81093b1eb0bb"></a>

\#define INS\_SYS\_SET\_IDLE\_TEXT   0x13

Set the text displayed in the idle sceen (replaces the welcome text if set)

### INS\_SYS\_SET\_PROPERTY <a href="#af8dac5fd1f8896a26d7a7c5045470a56" id="af8dac5fd1f8896a26d7a7c5045470a56"></a>

\#define INS\_SYS\_SET\_PROPERTY   0x19

Serialized [sysSetPropertyInt()](/adk-5.0-programmers-guide/readme/modules/group__led/namespacevfisysinfo.md#a377307b06ac969f30af51e7cccf94dbb)/sysSetPropertyString() command.

### INS\_SYS\_SET\_STATUS <a href="#ac67f66838ed245959518c01ba263c077" id="ac67f66838ed245959518c01ba263c077"></a>

\#define INS\_SYS\_SET\_STATUS   0x09

Set device status info.

### INS\_SYS\_SHUTDOWN\_REBOOT\_SLEEP <a href="#a3ab736555cafdb3b2edc7576a8fa090d" id="a3ab736555cafdb3b2edc7576a8fa090d"></a>

\#define INS\_SYS\_SHUTDOWN\_REBOOT\_SLEEP   0x17

Shutdown, reboot or set the terminal to sleep.

### INS\_SYS\_STATISTIC\_COUNTERS <a href="#a4c5cfffd6c0688eab9b0ef3f67bf196f" id="a4c5cfffd6c0688eab9b0ef3f67bf196f"></a>

\#define INS\_SYS\_STATISTIC\_COUNTERS   0x25

Statistic Counters.

### INS\_SYS\_SW\_GET\_LAST\_INSTALL\_ERROR <a href="#a3270a127f531045f7684ef1347020658" id="a3270a127f531045f7684ef1347020658"></a>

\#define INS\_SYS\_SW\_GET\_LAST\_INSTALL\_ERROR   0x1E

Get last install error from secure installer and reset.

### INS\_SYS\_SW\_UPLOAD\_FINALIZE <a href="#aab035bdcfd31ec20cede910f2dd11be4" id="aab035bdcfd31ec20cede910f2dd11be4"></a>

\#define INS\_SYS\_SW\_UPLOAD\_FINALIZE   0x16

Finalize a software upload.

### INS\_SYS\_SW\_UPLOAD\_START <a href="#a3ed8b7fb7f077ce09888eeefd0e6ba30" id="a3ed8b7fb7f077ce09888eeefd0e6ba30"></a>

\#define INS\_SYS\_SW\_UPLOAD\_START   0x14

Start a software upload.

### INS\_SYS\_SW\_UPLOAD\_TRANSFER <a href="#a586ae83176f7669aca82a81a762f6021" id="a586ae83176f7669aca82a81a762f6021"></a>

\#define INS\_SYS\_SW\_UPLOAD\_TRANSFER   0x15

Transfer record data for software upload.

### INS\_SYS\_SYNC\_TURN\_ON <a href="#aea810192a402df0a33faa882ea076bc8" id="aea810192a402df0a33faa882ea076bc8"></a>

\#define INS\_SYS\_SYNC\_TURN\_ON   0x00

Turn On device.

### INS\_SYS\_TURN\_OFF <a href="#a88534d083ea20c7f0e05ede598f105d7" id="a88534d083ea20c7f0e05ede598f105d7"></a>

\#define INS\_SYS\_TURN\_OFF   0x01

Turn Off device.

### MAX\_OUT\_MSG\_SIZE\_A <a href="#a535a37cbfd7f58dd8f5dbdb69ababfd9" id="a535a37cbfd7f58dd8f5dbdb69ababfd9"></a>

\#define MAX\_OUT\_MSG\_SIZE\_A   0xFFF0

### MAX\_OUT\_MSG\_SIZE\_B\_C\_D <a href="#a0a4d3755c2b2df8a7d65e91e847f3f0b" id="a0a4d3755c2b2df8a7d65e91e847f3f0b"></a>

\#define MAX\_OUT\_MSG\_SIZE\_B\_C\_D   0xFFFF

### MIN <a href="#a3acffbd305ee72dcd4593c0d8af64a4f" id="a3acffbd305ee72dcd4593c0d8af64a4f"></a>

\#define MIN

### TypedefDocumentation <a href="#typedef-documentation" id="typedef-documentation"></a>

### Thread\_Data <a href="#a180fda2fed413013609591e0b565b8e8" id="a180fda2fed413013609591e0b565b8e8"></a>

typedef struct \[thread\_data]\(#structthread\_\_data) \[Thread\_Data]\(#a180fda2fed413013609591e0b565b8e8)

### EnumerationType Documentation <a href="#enumeration-type-documentation" id="enumeration-type-documentation"></a>

### ExtserverResult <a href="#a0ee277aec4317de742cf8b2bd40af3a9" id="a0ee277aec4317de742cf8b2bd40af3a9"></a>

enum \[ExtserverResult]\(#a0ee277aec4317de742cf8b2bd40af3a9)

Internal Extserver Result Values

|                                  |                                            |
| -------------------------------- | ------------------------------------------ |
| Enumerator                       |                                            |
| RESULT\_OK                       | No error                                   |
| RESULT\_FAIL                     | Generic error                              |
| RESULT\_TIMEOUT                  | Timeout occurred                           |
| RESULT\_USER\_CANCEL             | User cancellation                          |
| RESULT\_MOBILE\_ABORT            | Abort from mobile device received          |
| RESULT\_NO\_LINK                 | Link to mobile device interrupted          |
| RESULT\_CLEAR\_BUTTON            | clear button pressed                       |
| RESULT\_DATA\_AVAILABLE          | data available from slave device (e.g EPP) |
| RESULT\_EXCESSIVE\_PIN\_REQUESTS | Excessive PIN entry                        |
| RESULT\_TAG\_ERROR               | Tag error                                  |
| RESULT\_TAG\_LENGTH\_ERROR       | Tag length error                           |
| RESULT\_PARAMETER\_ERROR         | Parameter error                            |
| RESULT\_INTERCHAR\_TIMEOUT       | interchar timeout during input             |
| RESULT\_LOGIC\_ERROR             | Logic error (e.g. wrong command order)     |

### IdleLockType <a href="#acbca865bf1cc550151c765b4bb11dc7e" id="acbca865bf1cc550151c765b4bb11dc7e"></a>

enum \[IdleLockType]\(#acbca865bf1cc550151c765b4bb11dc7e)

|                |                                                                                      |
| -------------- | ------------------------------------------------------------------------------------ |
| Enumerator     |                                                                                      |
| ILT\_NoLock    | idle screen recently not locked                                                      |
| ILT\_ApiLock   | idle screen locked by [sysSetIdleScreenLocked()](#af0f2a2ccba88c6c9f0ee759172febaa0) |
| ILT\_AdminLock | idle screen locked by admin mode                                                     |

### IdleScreenMode <a href="#acdffce6b62c4db2a50dd9cdae6caba78" id="acdffce6b62c4db2a50dd9cdae6caba78"></a>

enum \[IdleScreenMode]\(#acdffce6b62c4db2a50dd9cdae6caba78)

\[TABLE]

### UploadType <a href="#a6cd49ae0288c8ad7e57768049b88e2c0" id="a6cd49ae0288c8ad7e57768049b88e2c0"></a>

enum \[UploadType]\(#a6cd49ae0288c8ad7e57768049b88e2c0)

Types for sw/file upload command

|                                       |                                                                                                                  |
| ------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
| Enumerator                            |                                                                                                                  |
| UPLOAD\_TYPE\_SOFTWARE\_UPDATE        | 0: Software update with SW upload 20-14/20-15/20-16                                                              |
| UPLOAD\_TYPE\_CONFIG\_WHITELIST       | 1: Whitelist configuration: whitelist.json with SW upload 20-14/20-15/20-16                                      |
| UPLOAD\_TYPE\_CONFIG\_SENSITIVE\_TAGS | 2: Sensitive tags configuration: sensitivetags.json with SW upload 20-14/20-15/20-16                             |
| UPLOAD\_TYPE\_CONFIG\_CARD\_RANGES    | 3: Card ranges configuration: cardranges.json with SW upload 20-14/20-15/20-16                                   |
| UPLOAD\_TYPE\_FIRMWARE\_UPDATE        | 4: Firmware update with check for update 20-1D                                                                   |
| UPLOAD\_TYPE\_KEYS                    | 5: Install keys with check for update 20-1D                                                                      |
| UPLOAD\_TYPE\_CONFIG\_SDIEMV          | 6: User configuration for SDI or EMV with check for update 20-1D                                                 |
| UPLOAD\_TYPE\_REMOVE\_SPONSOR         | 7: Remove sponsor certificates with check for update 20-1D                                                       |
| UPLOAD\_TYPE\_REMOVE\_CONFIG\_SDIEMV  | 8: Remove user configuration for SDI or EMV with check for update 20-1D                                          |
| UPLOAD\_TYPE\_PLUGIN                  | 9: Install SDI plugin(s) with check for update 20-1D                                                             |
| UPLOAD\_TYPE\_REMOVE\_PLUGIN          | 10: Remove SDI plugin(s) with check for update 20-1D                                                             |
| UPLOAD\_TYPE\_CP\_PACKAGE             | 11: Install commerce platform package with SW upload 20-14/20-15/20-16                                           |
| UPLOAD\_TYPE\_EMV\_CONFIG\_PACKAGE    | 12: Install EMV config package with SW upload 20-14/20-15/20-16                                                  |
| UPLOAD\_TYPE\_UVRK\_PACKAGE           | 13: Install UVRK package with SW upload 20-14/20-15/20-16. tar file \*.uvrk.tar with flat files of \*.vrk2.json. |
| UPLOAD\_TYPE\_MAX                     | !!! Must be the last entry, please insert before !!!                                                             |

### FunctionDocumentation <a href="#function-documentation" id="function-documentation"></a>

### check4Interrupt() <a href="#af8ff9f4a2125f866eda540eaf867197b" id="af8ff9f4a2125f866eda540eaf867197b"></a>

int check4Interrupt

Check if a SysAbort command is received or a Link interruption occurred

#### Returns

RESULT\_MOBILE\_ABORT if a SysAbort is received, RESULT\_NO\_LINK in case of link interrupt, else RESULT\_OK

### checkBundleInstalled() <a href="#a3aeb676c0c19ca74396503eb1267f979" id="a3aeb676c0c19ca74396503eb1267f979"></a>

bool checkBundleInstalled

check for installed bundle with name `bdlname`. String `bdlname` can be a regular expression.

**Parameters**

\[in] **bdlname** name of the bundle (or regex)

#### Returns

true if the bundle is installed, false in case that `bdlname` does not match an installed bundle

{% hint style="info" %}
This function works for VOS/VOS2 only. If invoked on other platforms it returns always false.
{% endhint %}

### errText() <a href="#ae05a33a2f7e55688d36a0692fc795ffe" id="ae05a33a2f7e55688d36a0692fc795ffe"></a>

const char\\\* errText

Return C-String of error ExtserverResult

#### Returns

C-String with error name, "UNKNOWN" for unknown error codes

### handleSystemCmd() <a href="#afe8ab8c8d592d69c0b6d074f03081d3e" id="afe8ab8c8d592d69c0b6d074f03081d3e"></a>

bool handleSystemCmd

Dispatch function to handle different system commands

**Parameters**

\[in] **msgBufSize** size of the input message buffer \[in] **msg** pointer to the input message buffer \[in] **msgSize** size of the input message \[in] **rspBufSize** maximum size of the response buffer \[in,out] **rsp** pointer to the response buffer \[in,out] **rspSize** pointer to the response message size

#### Returns

true if command was executed and rsp contains a response, false in case invocation is not allowed by a side command.

### isCardRemoved() <a href="#a43801947261b861981e5f2c52e878fa0" id="a43801947261b861981e5f2c52e878fa0"></a>

int isCardRemoved

Check if a Chip Card is removed

#### Returns

0 = Card inserted, 1 = Card removed

### isHwModelName() <a href="#aadbe3a6553fce242b52a2655173897fe" id="aadbe3a6553fce242b52a2655173897fe"></a>

bool isHwModelName

Check the Hardware Model Name of the device

**Parameters**

\[in] **targetHwModelName** target Hardware Model Name

#### Returns

true if the Hardware Model Name matches, false if the Hardware Model Name doesn't match

### isUX302() <a href="#a0e3f2c6c7758e8f0e2c1246d5d34862b" id="a0e3f2c6c7758e8f0e2c1246d5d34862b"></a>

bool isUX302

inline

### isUX412() <a href="#a238f9de29efff641b730a71ee5bc4bbb" id="a238f9de29efff641b730a71ee5bc4bbb"></a>

bool isUX412

inline

Check if the device is an UX412

#### Returns

true if the device is an UX412, else false

### setDevice2Idle() <a href="#ac28a8edfbaded7c71c0e249ae70aba3b" id="ac28a8edfbaded7c71c0e249ae70aba3b"></a>

void setDevice2Idle

Set the device into idle mode

### setInterrupt() <a href="#a86502db8f28fe31f7ee0266a97ee156a" id="a86502db8f28fe31f7ee0266a97ee156a"></a>

void setInterrupt

Make the check4Interrupt return not RESULT\_OK once.

### setSW1SW2() <a href="#a2b1e62cbba20fe441f74365bab09c22c" id="a2b1e62cbba20fe441f74365bab09c22c"></a>

void setSW1SW2

Map result to SW1/SW2

**Parameters**

\[in] **result** SDI result code \[in,out] **rsp** pointer to the response buffer

### sys\_internal\_android() <a href="#a914eb0ad5b455073caeed46e742f3cd2" id="a914eb0ad5b455073caeed46e742f3cd2"></a>

bool sys\_internal\_android

checks for device types, which run SDI server on Engage and the payment application on the internal Android device. A special internal network is used to connect both devices. Recently these are CM5, M440 and M424. Others like X10 or X8 shall not match, since payment application runs on Engage here.

#### Returns

true for internal android with payment application

### sysDisplayIdleScreen() <a href="#ad2bc24707c477aa4c2cb1c4fb92855df" id="ad2bc24707c477aa4c2cb1c4fb92855df"></a>

void sysDisplayIdleScreen

Display idle screen

**Parameters**

\[in] **mode** idle screen mode bit mask, see enum IdleScreenMode \[in] **idletext** optional text used in favor of standard or customer text

### sysGetIdleScreenLocked() <a href="#af826b34d72f2718baf08d472448063bd" id="af826b34d72f2718baf08d472448063bd"></a>

enum \[IdleLockType]\(#acbca865bf1cc550151c765b4bb11dc7e) sysGetIdleScreenLocked

Returns true, if idle screen was locked either by [sysSetIdleScreenLocked()](#af0f2a2ccba88c6c9f0ee759172febaa0) or admin mode w/o admin menu was turned on by [sysSetIdleScreenAdminMenu()](#af85581548b99a07d923feb33e0297b5c)

#### Returns

true, if idle screen is locked, else false

### sysResetUpdateContext() <a href="#a6777013b116ca3f41fc511143671ef8e" id="a6777013b116ca3f41fc511143671ef8e"></a>

void sysResetUpdateContext

Reset update context allocated for SW update with 20-14, 20-15, 20-16. The function is invoked by a thread at connection termination to abort a pending update which was started by command 20-14, but not completed with 20-15 and 20-16. SDI server supports multiple connections, which can use the update interface. With a started update with command 20-14 on one connection, the interface is locked for other connections. If a connection terminates, which obtains the update context (lock), the interface would be unaccessable for other connections. Therfore, this function will abort the started update and unlock the update interface, if the connection disturbes so that it can be used by other connection again.

**Parameters**

\[in] **handle** handle of the terminating connection

### sysSetIdleScreenAdminMenu() <a href="#af85581548b99a07d923feb33e0297b5c" id="af85581548b99a07d923feb33e0297b5c"></a>

void sysSetIdleScreenAdminMenu

Turn on the admin menu, if this was locked by admin mode (enabled by config). Next call of [sysDisplayIdleScreen()](#ad2bc24707c477aa4c2cb1c4fb92855df) with mode Idle\_MenuEnabled then will display idle screen with menu/info softkey/keyhelpers.

{% hint style="info" %}
This function has no effect, if admin mode is disabled (not enabled by config).
{% endhint %}

### sysSetIdleScreenFinished() <a href="#a02ab2d39fc437b5924aed122a8adb57e" id="a02ab2d39fc437b5924aed122a8adb57e"></a>

bool sysSetIdleScreenFinished

Function called by idlescreen callback to signal the return of idlescreen

**Parameters**

\[in] **id** idlescreen ID forwarded by idlescreen callback

#### Returns

true, if the last idle screen has display the admin menu, (for active admin mode) else false is returned.

### sysSetIdleScreenLocked() <a href="#af0f2a2ccba88c6c9f0ee759172febaa0" id="af0f2a2ccba88c6c9f0ee759172febaa0"></a>

bool sysSetIdleScreenLocked

Lock/Unlock the idle screen and disable/enable softkeys/keyhelpers to access the menu. If locked, further subsequent calls of [`sysDisplayIdleScreen()`](#ad2bc24707c477aa4c2cb1c4fb92855df) with mode `Idle_MenuEnabled` are suppressed and idle screen is displayed without softkeys/keyhelpers. Parameter `update_screen` (set to true) will replace an existing idle screen by a default idle screen by invoking function [sysDisplayIdleScreen()](#ad2bc24707c477aa4c2cb1c4fb92855df) with or without option Idle\_MenuEnabled depending on the new lock state `lock`.

**Parameters**

**lock** new lock state: true/false to lock/unlock the idle screen **update\_screen** update an existing idle screen and enable/disable menu according new lock state

#### Returns

old lock state (before this function was called): true, if the idlescreen was already locked false, if the idlescreen was already unlocked

{% hint style="info" %}
This function does nothing, if SDI admin mode was enabled by configuration. The admin mode defines another behavior for locking the idle screen (e.g. it must be always unlocked by key combination or touch. Thus, internal calls of this function, will be ignored
{% endhint %}

### vos\_sys8() <a href="#a7109ff8195a9046828f8120509022d76" id="a7109ff8195a9046828f8120509022d76"></a>

bool vos\_sys8

returns true, if SDI server runs on V/OS as system user sys8

#### Returns

true if running as sys8 user


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://sandbox-docs.verifone.com/adk-5.0-programmers-guide/readme/files/dir_44d926a17fc606d3c25449ba60427c63/dir_048f823fee1bfb22502a8732b9a001aa/sys_8h.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
