| <!DOCTYPE html> |
| <!-- |
| Copyright 2019 NXP |
| |
| This software is owned or controlled by NXP and may only be used |
| strictly in accordance with the applicable license terms. By expressly |
| accepting such terms or by downloading, installing, activating and/or |
| otherwise using the software, you are agreeing that you have read, and |
| that you agree to comply with and are bound by, such license terms. If |
| you do not agree to be bound by the applicable license terms, then you |
| may not retain, install, activate or otherwise use the software. |
| --> |
| |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta charset="utf-8" /> |
| <title>7.6. APIs — Plug & Trust MW v03.00.05 documentation</title> |
| <link rel="stylesheet" href="../../_static/bootstrap-sphinx.css" type="text/css" /> |
| <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" /> |
| <link rel="stylesheet" type="text/css" href="../../_static/graphviz.css" /> |
| <script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script> |
| <script src="../../_static/jquery.js"></script> |
| <script src="../../_static/underscore.js"></script> |
| <script src="../../_static/doctools.js"></script> |
| <script src="../../_static/language_data.js"></script> |
| <link rel="index" title="Index" href="../../genindex.html" /> |
| <link rel="search" title="Search" href="../../search.html" /> |
| <link rel="next" title="7.7. SEMS Lite Known Issue" href="sems_lite_known_issue.html" /> |
| <link rel="prev" title="7.5. SEMS Lite Agent Package Load Process" href="sems_lite_process.html" /> |
| <meta charset='utf-8'> |
| <meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'> |
| <meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'> |
| <meta name="apple-mobile-web-app-capable" content="yes"> |
| <script type="text/javascript" src="../../_static/js/jquery-1.11.0.min.js "></script> |
| <script type="text/javascript" src="../../_static/js/jquery-fix.js "></script> |
| <script type="text/javascript" src="../../_static/bootstrap-3.3.7/js/bootstrap.min.js "></script> |
| <script type="text/javascript" src="../../_static/bootstrap-sphinx.js "></script> |
| |
| </head><body> |
| |
| <div id="navbar" class="navbar navbar-inverse navbar-default navbar-fixed-top"> |
| <div class="container"> |
| <div class="navbar-header"> |
| <!-- .btn-navbar is used as the toggle for collapsed navbar content --> |
| <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".nav-collapse"> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| </button> |
| <a class="navbar-brand" href="../../toc.html"><span><img src="../../_static/NXP_logo_JPG.jpg"></span> |
| MW</a> |
| <span class="navbar-text navbar-version pull-left"><b>v03.00.05</b></span> |
| </div> |
| |
| <div class="collapse navbar-collapse nav-collapse"> |
| <ul class="nav navbar-nav"> |
| |
| |
| <li class="dropdown globaltoc-container"> |
| <a role="button" |
| id="dLabelGlobalToc" |
| data-toggle="dropdown" |
| data-target="#" |
| href="../../toc.html">TOC <b class="caret"></b></a> |
| <ul class="dropdown-menu globaltoc" |
| role="menu" |
| aria-labelledby="dLabelGlobalToc"><ul class="current"> |
| <li class="toctree-l1"><a class="reference internal" href="../../index.html">1. NXP Plug & Trust Middleware</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="../../organization-of-documentation.html">1.1. Organization of Documentation</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../folder-structure.html">1.2. Folder Structure</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../sw-prerequisites.html">1.3. List of Platform Prerequisites</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="../../changes/index.html">2. Changes</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="../../changes/pending.html">2.1. Pending Refactoring items</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../changes/pending.html#known-limitations">2.2. Known limitations</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../changes/v03_00_05.html">2.3. Release <code class="docutils literal notranslate"><span class="pre">v03.00.05</span></code></a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../changes/v03_00_04.html">2.4. Release <code class="docutils literal notranslate"><span class="pre">v03.00.04</span></code></a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../changes/v03_00_03.html">2.5. Release <code class="docutils literal notranslate"><span class="pre">v03.00.03</span></code></a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../changes/v03_00_02.html">2.6. Release <code class="docutils literal notranslate"><span class="pre">v03.00.02</span></code></a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../changes/v02_16_01.html">2.7. Release <code class="docutils literal notranslate"><span class="pre">v02.16.01</span></code></a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../changes/v02_16_00.html">2.8. Release <code class="docutils literal notranslate"><span class="pre">v02.16.00</span></code></a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../changes/v02_15_00.html">2.9. Release <code class="docutils literal notranslate"><span class="pre">v02.15.00</span></code></a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../changes/v02_14_00.html">2.10. Release <code class="docutils literal notranslate"><span class="pre">v02.14.00</span></code></a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../changes/v02_12_00.html">2.11. Release <code class="docutils literal notranslate"><span class="pre">v02.12.05</span></code></a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../changes/v02_12_00.html#release-v02-12-04">2.12. Release <code class="docutils literal notranslate"><span class="pre">v02.12.04</span></code></a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../changes/v02_12_00.html#release-v02-12-03">2.13. Release <code class="docutils literal notranslate"><span class="pre">v02.12.03</span></code></a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../changes/v02_12_00.html#release-v02-12-02">2.14. Release <code class="docutils literal notranslate"><span class="pre">v02.12.02</span></code></a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../changes/v02_12_00.html#release-v02-12-01">2.15. Release <code class="docutils literal notranslate"><span class="pre">v02.12.01</span></code></a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../changes/v02_12_00.html#release-v02-12-00">2.16. Release <code class="docutils literal notranslate"><span class="pre">v02.12.00</span></code></a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../changes/v02_11_03.html">2.17. Release <code class="docutils literal notranslate"><span class="pre">v02.11.03</span></code></a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../changes/v02_11_01.html">2.18. Internal Release <code class="docutils literal notranslate"><span class="pre">v02.11.01</span></code></a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../changes/v02_11_00.html">2.19. Release <code class="docutils literal notranslate"><span class="pre">v02.11.00</span></code></a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../changes/v02_10_00.html">2.20. Release <code class="docutils literal notranslate"><span class="pre">v02.10.00</span></code></a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../changes/v02_09_00.html">2.21. Release <code class="docutils literal notranslate"><span class="pre">v02.09.00</span></code></a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../changes/v02_07_00.html">2.22. Release <code class="docutils literal notranslate"><span class="pre">v02.07.00</span></code></a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../changes/v02_06_00.html">2.23. Release <code class="docutils literal notranslate"><span class="pre">v02.06.00</span></code></a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../changes/v02_05_00_to_v02_03_00.html">2.24. Release <code class="docutils literal notranslate"><span class="pre">v02.05.00</span></code></a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../changes/v02_05_00_to_v02_03_00.html#release-v02-04-00">2.25. Release <code class="docutils literal notranslate"><span class="pre">v02.04.00</span></code></a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../changes/v02_05_00_to_v02_03_00.html#release-02-03-00">2.26. Release <code class="docutils literal notranslate"><span class="pre">02.03.00</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="../../stack/index.html">3. Plug & Trust MW Stack</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="../../stack/features.html">3.1. Features</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../stack/features.html#plug-trust-mw-block-diagram">3.2. Plug & Trust MW : Block Diagram</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../sss-apis.html">3.3. SSS APIs</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../stack/se05xfeatures.html">3.4. SSS APIs: SE051 vs SE050</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../stack/param_checks.html">3.5. Parameter Check & Conventions</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../stack/i2cm.html">3.6. I2CM / Secure Sensor</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../stack/logging.html">3.7. Logging</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../stack/feature-file.html">3.8. Feature File - <code class="docutils literal notranslate"><span class="pre">fsl_sss_ftr.h</span></code></a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../stack/platf-scp-from-fs.html">3.9. Using Platform SCP Keys from File System</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../stack/auth/auth-objects.html">3.10. Auth Objects</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../stack/auth/auth-objects-userid.html">3.11. Auth Objects : UserID</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../stack/auth/auth-objects-aeskey.html">3.12. Auth Objects : AESKey</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../stack/auth/auth-objects-eckey.html">3.13. Auth Objects : ECKey</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../stack/key-id-range.html">3.14. Key Id Range and Purpose</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../stack/key-id-range.html#authentication-keys">3.15. Authentication Keys</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../stack/key-id-range.html#trust-provisioned-keyids">3.16. Trust provisioned KeyIDs</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../sss/ex/doc/puf-scp03.html">3.17. SCP03 with PUF</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../sss/doc/sss_heap_management.html">3.18. SSS Heap Management</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="../../building/index.html">4. Building / Compiling</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="../../building/windows.html">4.1. Windows Build</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../building/frdm-k64f-sdk.html">4.2. Import MCUXPresso projects from SDK</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../building/frdm-k64f-cmake.html">4.3. Freedom K64F Build (CMake - Advanced)</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../building/imx6.html">4.4. i.MX Linux Build</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../building/rpi3.html">4.5. Raspberry Pi Build</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../building/cmake.html">4.6. CMake</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../scripts/cmake_options.html">4.7. CMake Options</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="../../demos/index.html">5. Demo and Examples</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="../../demos/index.html#demo-list">5.1. Demo List</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../demos/index.html#sss-api-examples">5.2. SSS API Examples</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../demos/index.html#cloud-demos">5.3. Cloud Demos</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../demos/index.html#linux-specific-demos">5.4. Linux Specific Demos</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../demos/index.html#opc-ua-example">5.5. OPC-UA Example</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../demos/index.html#arm-psa-example">5.6. ARM PSA Example</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../demos/index.html#se05x-examples">5.7. SE05X Examples</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../demos/index.html#openssl-examples">5.8. OpenSSL Examples</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../demos/index.html#tests-for-user-crypto">5.9. Tests for User Crypto</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../demos/index.html#nxpnfcrdlib-examples">5.10. NXPNFCRDLIB examples</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../demos/index.html#ease-of-use-examples">5.11. Ease-of-Use examples</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../demos/index.html#semslite-examples">5.12. Semslite examples</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../demos/index.html#puf-examples">5.13. PUF examples</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="../../edgelock2go-agent.html">6. NXP EdgeLock 2GO Agent</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="../../nxp_iot_agent/doc/introduction.html">6.1. Introduction</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../nxp_iot_agent/doc/introduction.html#building-and-running-the-edgelock-2go-agent">6.2. Building and running the EdgeLock 2GO agent</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../nxp_iot_agent/doc/introduction.html#datastore-keystore">6.3. Datastore / Keystore</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../nxp_iot_agent/doc/introduction.html#connection-to-the-edgelock-2go-cloud-service">6.4. Connection to the EdgeLock 2GO cloud service</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../nxp_iot_agent/doc/introduction.html#claim-codes">6.5. Claim Codes</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../nxp_iot_agent/doc/edgelock2go_agent_apis.html">6.6. API</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../nxp_iot_agent/doc/readme_usage_examples.html">6.7. Usage Examples</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1 current"><a class="reference internal" href="index.html">7. SEMS Lite Agent</a><ul class="current"> |
| <li class="toctree-l2"><a class="reference internal" href="sems_lite_overview.html">7.1. SEMS Lite Overview (Only for SE051)</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="sems_lite_package.html">7.2. Update Package</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="sems_lite_usage.html">7.3. SEMS Lite Agent Usage</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="sems_lite_mgmt_api.html">7.4. SEMS Lite management APIs</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="sems_lite_process.html">7.5. SEMS Lite Agent Package Load Process</a></li> |
| <li class="toctree-l2 current"><a class="current reference internal" href="#">7.6. APIs</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="sems_lite_known_issue.html">7.7. SEMS Lite Known Issue</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="demo_update.html">7.8. SEMS Lite DEMOs</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="../../plugins/index.html">8. Plugins / Add-ins</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="../../sss/plugin/openssl/scripts/readme.html">8.1. Introduction on OpenSSL engine</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../sss/plugin/mbedtls/scripts/readme.html">8.2. Introduction on mbedTLS ALT Implementation</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../sss/plugin/psa/Readme.html">8.3. Platform Security Architecture</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../plugins/akm.html">8.4. Android Key master</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../sss/plugin/open62541/readme.html">8.5. Introduction on Open62541 (OPC UA stack)</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../plugins/wifiEAP/wifiEAP.html">8.6. WiFi EAP Demo with Raspberry Pi3</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../plugins/pkcs11.html">8.7. PKCS#11 Standalone Library</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="../../cli-tool.html">9. CLI Tool</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="../../pycli/doc/introduction.html">9.1. Introduction</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../pycli/doc/block-diagram.html">9.2. Block Diagram</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../pycli/doc/pre-steps.html">9.3. Steps needed before running <code class="docutils literal notranslate"><span class="pre">ssscli</span></code> tool</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../pycli/doc/running.html">9.4. Running the <code class="docutils literal notranslate"><span class="pre">ssscli</span></code> tool - Windows</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../pycli/Provisioning/readme.html">9.5. CLI Provisioning</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../pycli/doc/readme_usage_examples.html">9.6. Usage Examples</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../pycli/doc/cli_commands_list.html">9.7. List of <code class="docutils literal notranslate"><span class="pre">ssscli</span></code> commands</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../pycli/doc/cli_data_format.html">9.8. CLI Data formats</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../pycli/doc/cli_object_policy.html">9.9. Object Policies Through ssscli</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../appendix/upload_se05x_using_pycli.html">9.10. Upload keys and certificates to SE05X using ssscli tool</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="../../a71ch.html">10. A71CH</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="../../a71ch/a71ch_sss.html">10.1. A71CH and SSS API</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../a71ch/a71ch_miscellaneous.html">10.2. Miscellaneous</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../a71ch/a71ch_legacy_host_api.html">10.3. A71CH Legacy API</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../a71ch/a71ch_legacy_hlse_api.html">10.4. A71CH Legacy HLSE (Generic) API</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../a71ch/a71ch_configure_tool.html">10.5. A71CH Legacy Configure Tool</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="../../appendix.html">11. Appendix</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="../../appendix/glossary.html">11.1. Glossary</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../appendix/vcom.html">11.2. APDU Commands over VCOM</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../appendix/vs2019-setup.html">11.3. Visual Studio 2019 Setup</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../appendix/ide_mcux.html">11.4. Setting up MCUXPresso IDE</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../dev-platforms.html">11.5. Development Platforms</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../appendix/se_uid.html">11.6. How to get SE Platform Information and UID</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../appendix/version_info.html">11.7. Version Information</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../demos/Certificate_Chains/Readme.html">11.8. Certificate Chains</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../appendix/rjct_server.html">11.9. JRCP_v1 Server</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../appendix/platfscp.html">11.10. Using own Platform SCP03 Keys</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../appendix/apdu_write_to_buffer.html">11.11. Write APDU to buffer</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../api/api_list.html">11.12. Plug & Trust MW APIs</a></li> |
| </ul> |
| </li> |
| </ul> |
| </ul> |
| </li> |
| |
| <li class="dropdown"> |
| <a role="button" |
| id="dLabelLocalToc" |
| data-toggle="dropdown" |
| data-target="#" |
| href="#">Page <b class="caret"></b></a> |
| <ul class="dropdown-menu localtoc" |
| role="menu" |
| aria-labelledby="dLabelLocalToc"><ul> |
| <li><a class="reference internal" href="#">7.6. APIs</a></li> |
| </ul> |
| </ul> |
| </li> |
| |
| |
| |
| |
| |
| <li> |
| <a href="sems_lite_process.html" title="Previous Chapter: 7.5. SEMS Lite Agent Package Load Process"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm hidden-tablet">« 7.5. SEMS Lit...</span> |
| </a> |
| </li> |
| <li> |
| <a href="sems_lite_known_issue.html" title="Next Chapter: 7.7. SEMS Lite Known Issue"><span class="glyphicon glyphicon-chevron-right visible-sm"></span><span class="hidden-sm hidden-tablet">7.7. SEMS Lit... »</span> |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| </ul> |
| |
| |
| |
| </div> |
| </div> |
| </div> |
| |
| <div class="container"> |
| <div class="row"> |
| <div class="col-md-3"> |
| <div id="sidebar" class="bs-sidenav" role="complementary"> |
| |
| <div class="sidebar-header"> |
| <h3>Plug & Trust MW</h3> |
| </div> |
| |
| <div class="row"> |
| <ul class="current"> |
| <li class="toctree-l1"><a class="reference internal" href="../../index.html">1. NXP Plug & Trust Middleware</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../changes/index.html">2. Changes</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../stack/index.html">3. Plug & Trust MW Stack</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../building/index.html">4. Building / Compiling</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../demos/index.html">5. Demo and Examples</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../edgelock2go-agent.html">6. NXP EdgeLock 2GO Agent</a></li> |
| <li class="toctree-l1 current"><a class="reference internal" href="index.html">7. SEMS Lite Agent</a><ul class="current"> |
| <li class="toctree-l2"><a class="reference internal" href="sems_lite_overview.html">7.1. SEMS Lite Overview (Only for SE051)</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="sems_lite_package.html">7.2. Update Package</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="sems_lite_usage.html">7.3. SEMS Lite Agent Usage</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="sems_lite_mgmt_api.html">7.4. SEMS Lite management APIs</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="sems_lite_process.html">7.5. SEMS Lite Agent Package Load Process</a></li> |
| <li class="toctree-l2 current"><a class="current reference internal" href="#">7.6. APIs</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="sems_lite_known_issue.html">7.7. SEMS Lite Known Issue</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="demo_update.html">7.8. SEMS Lite DEMOs</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="../../plugins/index.html">8. Plugins / Add-ins</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../cli-tool.html">9. CLI Tool</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../a71ch.html">10. A71CH</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../appendix.html">11. Appendix</a></li> |
| </ul> |
| |
| </div> |
| <div class="row"> |
| <form class="form" action="../../search.html" method="get"> |
| <div class="form-group"> |
| <label for="Search">Search:</label> |
| <input type="text" name="q" class="form-control" placeholder="Search" /> |
| </div> |
| <input type="hidden" name="check_keywords" value="yes" /> |
| <input type="hidden" name="area" value="default" /> |
| </form> |
| </div> |
| </div> |
| </div> |
| <div class="body col-md-9 content" role="main"> |
| |
| <div class="section" id="apis"> |
| <h1><span class="section-number">7.6. </span>APIs<a class="headerlink" href="#apis" title="Permalink to this headline">¶</a></h1> |
| <dl class="group"> |
| <dt> |
| <em>group</em> <code class="sig-name descname">sems_lite_agent</code></dt> |
| <dd><p>API to load an available update package on the SE. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric">Typedefs</p> |
| <dl class="type"> |
| <dt> |
| <em class="property">typedef </em><a class="reference internal" href="../../api/structsems__lite___s_e_app_info_list__t.html#_CPPv425sems_lite_SEAppInfoList_t" title="sems_lite_SEAppInfoList_t">sems_lite_SEAppInfoList_t</a> <code class="sig-name descname">sems_lite_PKGInfoList_t</code><br /></dt> |
| <dd><p>Same as <a class="reference internal" href="../../api/structsems__lite___s_e_app_info_list__t.html#structsems__lite___s_e_app_info_list__t"><span class="std std-ref">sems_lite_SEAppInfoList_t</span></a> for for list of installed packages </p> |
| </dd></dl> |
| |
| </div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric">Functions</p> |
| <dl class="function"> |
| <dt> |
| <a class="reference internal" href="../../api/enum_fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70.html#_CPPv412sss_status_t" title="sss_status_t">sss_status_t</a> <code class="sig-name descname">sems_lite_agent_init_context</code><span class="sig-paren">(</span>sems_lite_agent_ctx_t *<em>context</em>, <a class="reference internal" href="../../api/structsss__session__t.html#_CPPv413sss_session_t" title="sss_session_t">sss_session_t</a> *<em>boot_ctx</em><span class="sig-paren">)</span><br /></dt> |
| <dd><p>Initialize SEMS Lite agent context. </p> |
| <p>This function is used to initialize SEMS Lite agent context.</p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>Status of the operation</p> |
| </dd> |
| <dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><span class="pre">context</span></code>: Pointer to sems lite agent context.</p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">boot_ctx</span></code>: Pointer to sss session context</p></li> |
| </ul> |
| </dd> |
| <dt><strong>Return Value</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><a class="reference internal" href="../../api/enum_sems__lite__agent__common_8h_1aa5b00ffd4bb90443ccc1700d2c2f11cd.html#sems__lite__agent__common_8h_1aa5b00ffd4bb90443ccc1700d2c2f11cdaf2eba9b10de33dada9540d50e4980a16"><span class="std std-ref"><span class="pre">kStatus_SEMS_Lite_Success</span></span></a></code>: The operation has completed successfully.</p></li> |
| <li><p><code class="docutils literal notranslate"><a class="reference internal" href="../../api/enum_sems__lite__agent__common_8h_1aa5b00ffd4bb90443ccc1700d2c2f11cd.html#sems__lite__agent__common_8h_1aa5b00ffd4bb90443ccc1700d2c2f11cdafbd72b499cf0ff172ed378228c945a54"><span class="std std-ref"><span class="pre">kStatus_SEMS_Lite_ERR_General</span></span></a></code>: The operation has failed. </p></li> |
| </ul> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="function"> |
| <dt> |
| <a class="reference internal" href="../../api/enum_sems__lite__agent__common_8h_1aa5b00ffd4bb90443ccc1700d2c2f11cd.html#_CPPv418sems_lite_status_t" title="sems_lite_status_t">sems_lite_status_t</a> <code class="sig-name descname">sems_lite_agent_load_package</code><span class="sig-paren">(</span>sems_lite_agent_ctx_t *<em>context</em>, <a class="reference internal" href="../../api/structmulticast__package__t.html#_CPPv419multicast_package_t" title="multicast_package_t">multicast_package_t</a> *<em>multiPkgBuf</em><span class="sig-paren">)</span><br /></dt> |
| <dd><p>Load Applet package. </p> |
| <p>This function load an available update package on the SE and assure the tearing safe update of the SE.</p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>Status of the operation</p> |
| </dd> |
| <dt><strong>Note</strong></dt><dd><p>More return codes would be added to request host to either retry or install older package. </p> |
| </dd> |
| <dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><span class="pre">context</span></code>: Pointer to sems lite agent context.</p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">pkgBuf</span></code>: Pointer to package. It must follow the format defined in <a class="reference internal" href="../../api/structmulticast__package__t.html#structmulticast__package__t"><span class="std std-ref">multicast_package_t</span></a>.</p></li> |
| </ul> |
| </dd> |
| <dt><strong>Return Value</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><a class="reference internal" href="../../api/enum_sems__lite__agent__common_8h_1aa5b00ffd4bb90443ccc1700d2c2f11cd.html#sems__lite__agent__common_8h_1aa5b00ffd4bb90443ccc1700d2c2f11cdaf2eba9b10de33dada9540d50e4980a16"><span class="std std-ref"><span class="pre">kStatus_SEMS_Lite_Success</span></span></a></code>: The operation has completed successfully.</p></li> |
| <li><p><code class="docutils literal notranslate"><a class="reference internal" href="../../api/enum_sems__lite__agent__common_8h_1aa5b00ffd4bb90443ccc1700d2c2f11cd.html#sems__lite__agent__common_8h_1aa5b00ffd4bb90443ccc1700d2c2f11cdac61689d04ee5eb2e0d03126dc81b04a8"><span class="std std-ref"><span class="pre">kStatus_SEMS_Lite_ERR_COM</span></span></a></code>: Communication to SE failed.</p></li> |
| <li><p><code class="docutils literal notranslate"><a class="reference internal" href="../../api/enum_sems__lite__agent__common_8h_1aa5b00ffd4bb90443ccc1700d2c2f11cd.html#sems__lite__agent__common_8h_1aa5b00ffd4bb90443ccc1700d2c2f11cdabeeaf25988d47cc6c3881092d6af09ef"><span class="std std-ref"><span class="pre">kStatus_SEMS_Lite_ERR_DoReRun</span></span></a></code>: Update not completed please provide update package again.</p></li> |
| <li><p><code class="docutils literal notranslate"><a class="reference internal" href="../../api/enum_sems__lite__agent__common_8h_1aa5b00ffd4bb90443ccc1700d2c2f11cd.html#sems__lite__agent__common_8h_1aa5b00ffd4bb90443ccc1700d2c2f11cda02311b81fffee38e84847f20ee2d8a56"><span class="std std-ref"><span class="pre">kStatus_SEMS_Lite_ERR_NotApplicable</span></span></a></code>: Update not applicable on this Chip/type.</p></li> |
| <li><p><code class="docutils literal notranslate"><a class="reference internal" href="../../api/enum_sems__lite__agent__common_8h_1aa5b00ffd4bb90443ccc1700d2c2f11cd.html#sems__lite__agent__common_8h_1aa5b00ffd4bb90443ccc1700d2c2f11cda3b5caf31337b9c0e29b75139e69c0e73"><span class="std std-ref"><span class="pre">kStatus_SEMS_Lite_ERR_DoRecovery</span></span></a></code>: Update can not be completed. Please provide recovery package, to roll back to last working version.</p></li> |
| <li><p><code class="docutils literal notranslate"><a class="reference internal" href="../../api/enum_sems__lite__agent__common_8h_1aa5b00ffd4bb90443ccc1700d2c2f11cd.html#sems__lite__agent__common_8h_1aa5b00ffd4bb90443ccc1700d2c2f11cda1a69eedf6a99e58f760e95126bf49572"><span class="std std-ref"><span class="pre">kStatus_SEMS_Lite_ERR_Fatal</span></span></a></code>: Unresolvable error. (This category of errors can only appear in testing of an update package, in the case of NXP updates this is testes before by NXP)</p></li> |
| <li><p><code class="docutils literal notranslate"><a class="reference internal" href="../../api/enum_sems__lite__agent__common_8h_1aa5b00ffd4bb90443ccc1700d2c2f11cd.html#sems__lite__agent__common_8h_1aa5b00ffd4bb90443ccc1700d2c2f11cda0fd88599fe151c8ce75c62afe2292727"><span class="std std-ref"><span class="pre">kStatus_SEMS_Lite_ERR_NotEnoughNVMemory</span></span></a></code>: Don’t have has enough NV memory for the SEMS Lite Script.</p></li> |
| <li><p><code class="docutils literal notranslate"><a class="reference internal" href="../../api/enum_sems__lite__agent__common_8h_1aa5b00ffd4bb90443ccc1700d2c2f11cd.html#sems__lite__agent__common_8h_1aa5b00ffd4bb90443ccc1700d2c2f11cda015a37b371c575a9a00a3fb5ddc0bee9"><span class="std std-ref"><span class="pre">kStatus_SEMS_Lite_ERR_NotEnoughTransientMemory</span></span></a></code>: Don’t have enough transient memory for the SEMS Lite Script .</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="function"> |
| <dt> |
| <a class="reference internal" href="../../api/enum_fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70.html#_CPPv412sss_status_t" title="sss_status_t">sss_status_t</a> <code class="sig-name descname">sems_lite_agent_session_close</code><span class="sig-paren">(</span>sems_lite_agent_ctx_t *<em>context</em><span class="sig-paren">)</span><br /></dt> |
| <dd><p>Close the connection to SEMS Lite Applet. </p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>The api status.</p> |
| </dd> |
| <dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><span class="pre">context</span></code>: The context</p></li> |
| </ul> |
| </dd> |
| <dt><strong>Return Value</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><a class="reference internal" href="../../api/enum_sems__lite__agent__common_8h_1aa5b00ffd4bb90443ccc1700d2c2f11cd.html#sems__lite__agent__common_8h_1aa5b00ffd4bb90443ccc1700d2c2f11cdaf2eba9b10de33dada9540d50e4980a16"><span class="std std-ref"><span class="pre">kStatus_SEMS_Lite_Success</span></span></a></code>: Could close connection 1.</p></li> |
| <li><p><code class="docutils literal notranslate"><a class="reference internal" href="../../api/enum_sems__lite__agent__common_8h_1aa5b00ffd4bb90443ccc1700d2c2f11cd.html#sems__lite__agent__common_8h_1aa5b00ffd4bb90443ccc1700d2c2f11cdafbd72b499cf0ff172ed378228c945a54"><span class="std std-ref"><span class="pre">kStatus_SEMS_Lite_ERR_General</span></span></a></code>: Could not close connection 1. </p></li> |
| </ul> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="function"> |
| <dt> |
| <a class="reference internal" href="../../api/enum_fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70.html#_CPPv412sss_status_t" title="sss_status_t">sss_status_t</a> <code class="sig-name descname">sems_lite_agent_session_open</code><span class="sig-paren">(</span>sems_lite_agent_ctx_t *<em>context</em><span class="sig-paren">)</span><br /></dt> |
| <dd><p>Open a Physical connection to SEMS Lite Applet. </p> |
| <p>Calling this API opens Locical Connection 1 and selecs the SEMS Lite applet.</p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>The api status.</p> |
| </dd> |
| <dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><span class="pre">context</span></code>: SEMS Lite Agent Context</p></li> |
| </ul> |
| </dd> |
| <dt><strong>Return Value</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><a class="reference internal" href="../../api/enum_sems__lite__agent__common_8h_1aa5b00ffd4bb90443ccc1700d2c2f11cd.html#sems__lite__agent__common_8h_1aa5b00ffd4bb90443ccc1700d2c2f11cdaf2eba9b10de33dada9540d50e4980a16"><span class="std std-ref"><span class="pre">kStatus_SEMS_Lite_Success</span></span></a></code>: Could connect to SEMS Lite Applet.</p></li> |
| <li><p><code class="docutils literal notranslate"><a class="reference internal" href="../../api/enum_sems__lite__agent__common_8h_1aa5b00ffd4bb90443ccc1700d2c2f11cd.html#sems__lite__agent__common_8h_1aa5b00ffd4bb90443ccc1700d2c2f11cdafbd72b499cf0ff172ed378228c945a54"><span class="std std-ref"><span class="pre">kStatus_SEMS_Lite_ERR_General</span></span></a></code>: Could not connect to SEMS Lite Applet. </p></li> |
| </ul> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="function"> |
| <dt> |
| <a class="reference internal" href="../../api/enum_fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70.html#_CPPv412sss_status_t" title="sss_status_t">sss_status_t</a> <code class="sig-name descname">sems_lite_check_AppletRecoveryStatus</code><span class="sig-paren">(</span>sems_lite_agent_ctx_t *<em>pContext</em>, <a class="reference internal" href="../../api/enum_sems__lite__api_8h_1a4d49b22d5ac84006f10f199b3e66e175.html#_CPPv427sems_lite_recovery_status_t" title="sems_lite_recovery_status_t">sems_lite_recovery_status_t</a> *<em>pRecoveryStatus</em><span class="sig-paren">)</span><br /></dt> |
| <dd><p>Check Applet Recovery Status. </p> |
| <p>This API will return the status of applet recovery status</p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>Status of the operation</p> |
| </dd> |
| <dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><span class="pre">pContext</span></code>: Pointer to sems lite agent context.</p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">pRecoveryStatus</span></code>: Pointer to recovery status.</p></li> |
| </ul> |
| </dd> |
| <dt><strong>Return Value</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><a class="reference internal" href="../../api/enum_fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70.html#fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70abbddf43382dda6bce2ae5fd96fcfc97c"><span class="std std-ref"><span class="pre">kStatus_SSS_Success</span></span></a></code>: The operation has completed successfully.</p></li> |
| <li><p><code class="docutils literal notranslate"><a class="reference internal" href="../../api/enum_fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70.html#fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70a32741fa0bf21fca96d56375fc8f826e2"><span class="std std-ref"><span class="pre">kStatus_SSS_Fail</span></span></a></code>: The operation has failed. </p></li> |
| </ul> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="function"> |
| <dt> |
| <a class="reference internal" href="../../api/enum_fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70.html#_CPPv412sss_status_t" title="sss_status_t">sss_status_t</a> <code class="sig-name descname">sems_lite_check_AppletUpgradeProgress</code><span class="sig-paren">(</span>sems_lite_agent_ctx_t *<em>pContext</em>, <a class="reference internal" href="../../api/enum_sems__lite__api_8h_1a86f593f8ce75554015c993e19ab3409c.html#_CPPv434sems_lite_upgradeProgress_status_t" title="sems_lite_upgradeProgress_status_t">sems_lite_upgradeProgress_status_t</a> *<em>pUpgradeStatus</em><span class="sig-paren">)</span><br /></dt> |
| <dd><p>Check Applet Upgrade Progress. </p> |
| <p>This API will return the status of applet upgrade progress status</p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>Status of the operation</p> |
| </dd> |
| <dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><span class="pre">pContext</span></code>: Pointer to sems lite agent context.</p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">pUpgradeStatus</span></code>: Pointer to upgrade status.</p></li> |
| </ul> |
| </dd> |
| <dt><strong>Return Value</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><a class="reference internal" href="../../api/enum_fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70.html#fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70abbddf43382dda6bce2ae5fd96fcfc97c"><span class="std std-ref"><span class="pre">kStatus_SSS_Success</span></span></a></code>: The operation has completed successfully.</p></li> |
| <li><p><code class="docutils literal notranslate"><a class="reference internal" href="../../api/enum_fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70.html#fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70a32741fa0bf21fca96d56375fc8f826e2"><span class="std std-ref"><span class="pre">kStatus_SSS_Fail</span></span></a></code>: The operation has failed. </p></li> |
| </ul> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="function"> |
| <dt> |
| <a class="reference internal" href="../../api/enum_fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70.html#_CPPv412sss_status_t" title="sss_status_t">sss_status_t</a> <code class="sig-name descname">sems_lite_check_Tear</code><span class="sig-paren">(</span>sems_lite_agent_ctx_t *<em>pContext</em>, <a class="reference internal" href="../../api/enum_sems__lite__api_8h_1a72c84cc7f9508e6abe222a8d404130de.html#_CPPv427sems_lite_tearDown_status_t" title="sems_lite_tearDown_status_t">sems_lite_tearDown_status_t</a> *<em>pTearStatus</em><span class="sig-paren">)</span><br /></dt> |
| <dd><p>Check Tear during script execution. </p> |
| <p>This API will check whether there was tear during script execution</p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>Status of the operation</p> |
| </dd> |
| <dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><span class="pre">pContext</span></code>: Pointer to sems lite agent context.</p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">pTearStatus</span></code>: Pointer to tear status.</p></li> |
| </ul> |
| </dd> |
| <dt><strong>Return Value</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><a class="reference internal" href="../../api/enum_fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70.html#fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70abbddf43382dda6bce2ae5fd96fcfc97c"><span class="std std-ref"><span class="pre">kStatus_SSS_Success</span></span></a></code>: The operation has completed successfully.</p></li> |
| <li><p><code class="docutils literal notranslate"><a class="reference internal" href="../../api/enum_fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70.html#fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70a32741fa0bf21fca96d56375fc8f826e2"><span class="std std-ref"><span class="pre">kStatus_SSS_Fail</span></span></a></code>: The operation has failed. </p></li> |
| </ul> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="function"> |
| <dt> |
| <a class="reference internal" href="../../api/enum_fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70.html#_CPPv412sss_status_t" title="sss_status_t">sss_status_t</a> <code class="sig-name descname">sems_lite_get_AgentVersion</code><span class="sig-paren">(</span>uint8_t *<em>pRspBuf</em>, size_t *<em>pRspBufLen</em><span class="sig-paren">)</span><br /></dt> |
| <dd><p>Get the SEMS Lite Agent version. </p> |
| <p>This API will return the SEMS Lite Agent Version no.</p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>Status of the operation</p> |
| </dd> |
| <dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><span class="pre">pRspBuf</span></code>: Pointer to response Buffer.</p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">pRspBufLen</span></code>: Pointer to length of the response Buffer</p></li> |
| </ul> |
| </dd> |
| <dt><strong>Return Value</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><a class="reference internal" href="../../api/enum_fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70.html#fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70abbddf43382dda6bce2ae5fd96fcfc97c"><span class="std std-ref"><span class="pre">kStatus_SSS_Success</span></span></a></code>: The operation has completed successfully.</p></li> |
| <li><p><code class="docutils literal notranslate"><a class="reference internal" href="../../api/enum_fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70.html#fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70a32741fa0bf21fca96d56375fc8f826e2"><span class="std std-ref"><span class="pre">kStatus_SSS_Fail</span></span></a></code>: The operation has failed. </p></li> |
| </ul> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="function"> |
| <dt> |
| <a class="reference internal" href="../../api/enum_fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70.html#_CPPv412sss_status_t" title="sss_status_t">sss_status_t</a> <code class="sig-name descname">sems_lite_get_AppletVersion</code><span class="sig-paren">(</span>sems_lite_agent_ctx_t *<em>pContext</em>, uint8_t *<em>pRspBuf</em>, size_t *<em>pRspBufLen</em><span class="sig-paren">)</span><br /></dt> |
| <dd><p>Get the Applet version. </p> |
| <p>This API will return the SEMS Lite Applet Version no.</p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>Status of the operation</p> |
| </dd> |
| <dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><span class="pre">pContext</span></code>: Pointer to sems lite agent context.</p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">pRspBuf</span></code>: Pointer to response Buffer.</p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">pRspBufLen</span></code>: Pointer to length of the response Buffer</p></li> |
| </ul> |
| </dd> |
| <dt><strong>Return Value</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><a class="reference internal" href="../../api/enum_fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70.html#fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70abbddf43382dda6bce2ae5fd96fcfc97c"><span class="std std-ref"><span class="pre">kStatus_SSS_Success</span></span></a></code>: The operation has completed successfully.</p></li> |
| <li><p><code class="docutils literal notranslate"><a class="reference internal" href="../../api/enum_fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70.html#fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70a32741fa0bf21fca96d56375fc8f826e2"><span class="std std-ref"><span class="pre">kStatus_SSS_Fail</span></span></a></code>: The operation has failed. </p></li> |
| </ul> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="function"> |
| <dt> |
| <a class="reference internal" href="../../api/enum_fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70.html#_CPPv412sss_status_t" title="sss_status_t">sss_status_t</a> <code class="sig-name descname">sems_lite_get_available_mem</code><span class="sig-paren">(</span>sems_lite_agent_ctx_t *<em>pContext</em>, uint8_t *<em>pAvailableMem</em><span class="sig-paren">)</span><br /></dt> |
| <dd><p>{ function_description } </p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>The sss status. </p> |
| </dd> |
| <dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><span class="pre">context</span></code>: The context </p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">pAvailableMem</span></code>: Availalbe Memory Space Information</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="function"> |
| <dt> |
| <a class="reference internal" href="../../api/enum_fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70.html#_CPPv412sss_status_t" title="sss_status_t">sss_status_t</a> <code class="sig-name descname">sems_lite_get_CA_identifier</code><span class="sig-paren">(</span>sems_lite_agent_ctx_t *<em>pContext</em>, uint8_t *<em>pRspBuf</em>, size_t *<em>pRspBufLen</em><span class="sig-paren">)</span><br /></dt> |
| <dd><p>Get the CA Identifier. </p> |
| <p>This API will return the CA Identifier.</p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>Status of the operation</p> |
| </dd> |
| <dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><span class="pre">pContext</span></code>: Pointer to sems lite agent context.</p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">pRspBuf</span></code>: Pointer to response Buffer.</p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">pRspBufLen</span></code>: Pointer to length of the response Buffer</p></li> |
| </ul> |
| </dd> |
| <dt><strong>Return Value</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><a class="reference internal" href="../../api/enum_fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70.html#fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70abbddf43382dda6bce2ae5fd96fcfc97c"><span class="std std-ref"><span class="pre">kStatus_SSS_Success</span></span></a></code>: The operation has completed successfully.</p></li> |
| <li><p><code class="docutils literal notranslate"><a class="reference internal" href="../../api/enum_fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70.html#fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70a32741fa0bf21fca96d56375fc8f826e2"><span class="std std-ref"><span class="pre">kStatus_SSS_Fail</span></span></a></code>: The operation has failed. </p></li> |
| </ul> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="function"> |
| <dt> |
| <a class="reference internal" href="../../api/enum_fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70.html#_CPPv412sss_status_t" title="sss_status_t">sss_status_t</a> <code class="sig-name descname">sems_lite_get_ENCIdentifier</code><span class="sig-paren">(</span>sems_lite_agent_ctx_t *<em>pContext</em>, uint8_t *<em>pRspBuf</em>, size_t *<em>pRspBufLen</em><span class="sig-paren">)</span><br /></dt> |
| <dd><p>Get the ENC Identifier. </p> |
| <p>This API will return the ENC Identifier.</p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>Status of the operation</p> |
| </dd> |
| <dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><span class="pre">pContext</span></code>: Pointer to sems lite agent context.</p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">pRspBuf</span></code>: Pointer to response Buffer.</p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">pRspBufLen</span></code>: Pointer to length of the response Buffer</p></li> |
| </ul> |
| </dd> |
| <dt><strong>Return Value</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><a class="reference internal" href="../../api/enum_fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70.html#fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70abbddf43382dda6bce2ae5fd96fcfc97c"><span class="std std-ref"><span class="pre">kStatus_SSS_Success</span></span></a></code>: The operation has completed successfully.</p></li> |
| <li><p><code class="docutils literal notranslate"><a class="reference internal" href="../../api/enum_fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70.html#fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70a32741fa0bf21fca96d56375fc8f826e2"><span class="std std-ref"><span class="pre">kStatus_SSS_Fail</span></span></a></code>: The operation has failed. </p></li> |
| </ul> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="function"> |
| <dt> |
| <a class="reference internal" href="../../api/enum_fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70.html#_CPPv412sss_status_t" title="sss_status_t">sss_status_t</a> <code class="sig-name descname">sems_lite_get_FIPS_EC_parameter_type</code><span class="sig-paren">(</span>sems_lite_agent_ctx_t *<em>pContext</em>, uint8_t *<em>pParamType</em><span class="sig-paren">)</span><br /></dt> |
| <dd><p>Get Configured EC domain parameter type. </p> |
| <p>This API will return Configured EC domain parameter type</p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>Status of the operation</p> |
| </dd> |
| <dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><span class="pre">pContext</span></code>: Pointer to sems lite agent context.</p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">pParamType</span></code>: Pointer to parameter type.</p></li> |
| </ul> |
| </dd> |
| <dt><strong>Return Value</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><a class="reference internal" href="../../api/enum_fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70.html#fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70abbddf43382dda6bce2ae5fd96fcfc97c"><span class="std std-ref"><span class="pre">kStatus_SSS_Success</span></span></a></code>: The operation has completed successfully.</p></li> |
| <li><p><code class="docutils literal notranslate"><a class="reference internal" href="../../api/enum_fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70.html#fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70a32741fa0bf21fca96d56375fc8f826e2"><span class="std std-ref"><span class="pre">kStatus_SSS_Fail</span></span></a></code>: The operation has failed. </p></li> |
| </ul> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="function"> |
| <dt> |
| <a class="reference internal" href="../../api/enum_fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70.html#_CPPv412sss_status_t" title="sss_status_t">sss_status_t</a> <code class="sig-name descname">sems_lite_get_FIPS_info</code><span class="sig-paren">(</span>sems_lite_agent_ctx_t *<em>pContext</em>, uint8_t *<em>pFIPSInfo</em><span class="sig-paren">)</span><br /></dt> |
| <dd><p>Get Configured FIPS Information. </p> |
| <p>This API will return Configured FIPS Information</p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>Status of the operation</p> |
| </dd> |
| <dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><span class="pre">pContext</span></code>: Pointer to sems lite agent context.</p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">pFIPSInfo</span></code>: Pointer to FIPS Info.</p></li> |
| </ul> |
| </dd> |
| <dt><strong>Return Value</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><a class="reference internal" href="../../api/enum_fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70.html#fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70abbddf43382dda6bce2ae5fd96fcfc97c"><span class="std std-ref"><span class="pre">kStatus_SSS_Success</span></span></a></code>: The operation has completed successfully.</p></li> |
| <li><p><code class="docutils literal notranslate"><a class="reference internal" href="../../api/enum_fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70.html#fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70a32741fa0bf21fca96d56375fc8f826e2"><span class="std std-ref"><span class="pre">kStatus_SSS_Fail</span></span></a></code>: The operation has failed. </p></li> |
| </ul> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="function"> |
| <dt> |
| <a class="reference internal" href="../../api/enum_fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70.html#_CPPv412sss_status_t" title="sss_status_t">sss_status_t</a> <code class="sig-name descname">sems_lite_get_Publickey</code><span class="sig-paren">(</span>sems_lite_agent_ctx_t *<em>pContext</em>, uint8_t *<em>pRspBuf</em>, size_t *<em>pRspBufLen</em><span class="sig-paren">)</span><br /></dt> |
| <dd><p>Read Public Key. </p> |
| <p>This API will read root certificates public key of the device.</p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>Status of the operation</p> |
| </dd> |
| <dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><span class="pre">pContext</span></code>: Pointer to sems lite agent context.</p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">pRspBuf</span></code>: Pointer to response Buffer.</p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">pRspBufLen</span></code>: Pointer to length of the response Buffer.</p></li> |
| </ul> |
| </dd> |
| <dt><strong>Return Value</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><a class="reference internal" href="../../api/enum_fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70.html#fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70abbddf43382dda6bce2ae5fd96fcfc97c"><span class="std std-ref"><span class="pre">kStatus_SSS_Success</span></span></a></code>: The operation has completed successfully.</p></li> |
| <li><p><code class="docutils literal notranslate"><a class="reference internal" href="../../api/enum_fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70.html#fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70a32741fa0bf21fca96d56375fc8f826e2"><span class="std std-ref"><span class="pre">kStatus_SSS_Fail</span></span></a></code>: The operation has failed. </p></li> |
| </ul> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="function"> |
| <dt> |
| <a class="reference internal" href="../../api/enum_fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70.html#_CPPv412sss_status_t" title="sss_status_t">sss_status_t</a> <code class="sig-name descname">sems_lite_get_SEAppInfo</code><span class="sig-paren">(</span>sems_lite_agent_ctx_t *<em>pContext</em>, <em class="property">const</em> uint8_t *<em>searchAID</em>, uint8_t <em>searchAidLen</em>, <a class="reference internal" href="../../api/structsems__lite___s_e_app_info_list__t.html#_CPPv425sems_lite_SEAppInfoList_t" title="sems_lite_SEAppInfoList_t">sems_lite_SEAppInfoList_t</a> *<em>pAppInfo</em>, size_t *<em>pAppInfoLen</em><span class="sig-paren">)</span><br /></dt> |
| <dd><p>Low level API to get App INFO from the SE according to format mentioned in - Table 11-36: GlobalPlatform Registry Data (TLV), GPCardSpc_v2.2.pdf. </p> |
| <p>This API will read the currently present Applications ELF/ELM AIDs and versions as well as the present instances from the SE.</p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>Status of the operation</p> |
| </dd> |
| <dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><span class="pre">pContext</span></code>: Pointer to sems lite agent context.</p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">searchAID</span></code>: The search aid</p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">searchAidLen</span></code>: The search aid length</p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">pAppInfo</span></code>: Parsed structures</p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">[inout]</span> <span class="pre">pAppInfoLen</span></code>: Length of parsed structures.</p></li> |
| </ul> |
| </dd> |
| <dt><strong>Return Value</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><a class="reference internal" href="../../api/enum_fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70.html#fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70abbddf43382dda6bce2ae5fd96fcfc97c"><span class="std std-ref"><span class="pre">kStatus_SSS_Success</span></span></a></code>: The operation has completed successfully.</p></li> |
| <li><p><code class="docutils literal notranslate"><a class="reference internal" href="../../api/enum_fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70.html#fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70a32741fa0bf21fca96d56375fc8f826e2"><span class="std std-ref"><span class="pre">kStatus_SSS_Fail</span></span></a></code>: The operation has failed. </p></li> |
| </ul> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="function"> |
| <dt> |
| <a class="reference internal" href="../../api/enum_fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70.html#_CPPv412sss_status_t" title="sss_status_t">sss_status_t</a> <code class="sig-name descname">sems_lite_get_SEAppInfoRAW</code><span class="sig-paren">(</span>sems_lite_agent_ctx_t *<em>pContext</em>, <em class="property">const</em> uint8_t *<em>searchAID</em>, uint8_t <em>searchAidLen</em>, uint8_t *<em>pRspBuf</em>, size_t *<em>pRspBufLen</em><span class="sig-paren">)</span><br /></dt> |
| <dd><p>Low level API to get Raw App INFO from the SE. </p> |
| <p>This API will read the currently present Applications ELF/ELM AIDs and versions as well as the present instances from the SE.</p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>Status of the operation</p> |
| </dd> |
| <dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><span class="pre">pContext</span></code>: Pointer to sems lite agent context.</p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">[out]</span> <span class="pre">pRspBuf</span></code>: Pointer to response Buffer.</p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">searchAID</span></code>: The search aid</p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">searchAidLen</span></code>: The search aid length</p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">[inout]</span> <span class="pre">pRspBufLen</span></code>: Pointer to length of the response Buffer.</p></li> |
| </ul> |
| </dd> |
| <dt><strong>Return Value</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><a class="reference internal" href="../../api/enum_fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70.html#fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70abbddf43382dda6bce2ae5fd96fcfc97c"><span class="std std-ref"><span class="pre">kStatus_SSS_Success</span></span></a></code>: The operation has completed successfully.</p></li> |
| <li><p><code class="docutils literal notranslate"><a class="reference internal" href="../../api/enum_fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70.html#fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70a32741fa0bf21fca96d56375fc8f826e2"><span class="std std-ref"><span class="pre">kStatus_SSS_Fail</span></span></a></code>: The operation has failed. </p></li> |
| </ul> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="function"> |
| <dt> |
| <a class="reference internal" href="../../api/enum_fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70.html#_CPPv412sss_status_t" title="sss_status_t">sss_status_t</a> <code class="sig-name descname">sems_lite_get_SEPkgInfo</code><span class="sig-paren">(</span>sems_lite_agent_ctx_t *<em>pContext</em>, <em class="property">const</em> uint8_t *<em>searchAID</em>, uint8_t <em>searchAidLen</em>, <a class="reference internal" href="../../api/structsems__lite___s_e_app_info_list__t.html#_CPPv425sems_lite_SEAppInfoList_t" title="sems_lite_SEAppInfoList_t">sems_lite_SEAppInfoList_t</a> *<em>pAppInfo</em>, size_t *<em>pAppInfoLen</em><span class="sig-paren">)</span><br /></dt> |
| <dd><p>Low level API to get PKG INFO from the SE according to format mentioned in - Table 11-36: GlobalPlatform Registry Data (TLV), GPCardSpc_v2.2.pdf. </p> |
| <p>This API will read the currently present Applications ELF/ELM AIDs and versions as well as the present instances from the SE.</p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>Status of the operation</p> |
| </dd> |
| <dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><span class="pre">pContext</span></code>: Pointer to sems lite agent context.</p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">searchAID</span></code>: The search aid</p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">searchAidLen</span></code>: The search aid length</p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">pAppInfo</span></code>: Parsed structures</p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">[inout]</span> <span class="pre">pAppInfoLen</span></code>: Length of parsed structures.</p></li> |
| </ul> |
| </dd> |
| <dt><strong>Return Value</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><a class="reference internal" href="../../api/enum_fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70.html#fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70abbddf43382dda6bce2ae5fd96fcfc97c"><span class="std std-ref"><span class="pre">kStatus_SSS_Success</span></span></a></code>: The operation has completed successfully.</p></li> |
| <li><p><code class="docutils literal notranslate"><a class="reference internal" href="../../api/enum_fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70.html#fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70a32741fa0bf21fca96d56375fc8f826e2"><span class="std std-ref"><span class="pre">kStatus_SSS_Fail</span></span></a></code>: The operation has failed. </p></li> |
| </ul> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="function"> |
| <dt> |
| <a class="reference internal" href="../../api/enum_fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70.html#_CPPv412sss_status_t" title="sss_status_t">sss_status_t</a> <code class="sig-name descname">sems_lite_get_SEPkgInfoRAW</code><span class="sig-paren">(</span>sems_lite_agent_ctx_t *<em>pContext</em>, <em class="property">const</em> uint8_t *<em>searchAID</em>, uint8_t <em>searchAidLen</em>, uint8_t *<em>pRspBuf</em>, size_t *<em>pRspBufLen</em><span class="sig-paren">)</span><br /></dt> |
| <dd><p>Low level API to get RAW PKG INFO from the SE. </p> |
| <p>This API will read the currently present Applications ELF/ELM AIDs and versions as well as the present instances from the SE.</p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>Status of the operation</p> |
| </dd> |
| <dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><span class="pre">pContext</span></code>: Pointer to sems lite agent context.</p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">searchAID</span></code>: The search aid</p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">searchAidLen</span></code>: The search aid length</p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">[out]</span> <span class="pre">pRspBuf</span></code>: Pointer to response Buffer.</p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">[inout]</span> <span class="pre">pRspBufLen</span></code>: Pointer to length of the response Buffer.</p></li> |
| </ul> |
| </dd> |
| <dt><strong>Return Value</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><a class="reference internal" href="../../api/enum_fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70.html#fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70abbddf43382dda6bce2ae5fd96fcfc97c"><span class="std std-ref"><span class="pre">kStatus_SSS_Success</span></span></a></code>: The operation has completed successfully.</p></li> |
| <li><p><code class="docutils literal notranslate"><a class="reference internal" href="../../api/enum_fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70.html#fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70a32741fa0bf21fca96d56375fc8f826e2"><span class="std std-ref"><span class="pre">kStatus_SSS_Fail</span></span></a></code>: The operation has failed. </p></li> |
| </ul> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="function"> |
| <dt> |
| <a class="reference internal" href="../../api/enum_fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70.html#_CPPv412sss_status_t" title="sss_status_t">sss_status_t</a> <code class="sig-name descname">sems_lite_get_SignatureofLastScript</code><span class="sig-paren">(</span>sems_lite_agent_ctx_t *<em>pContext</em>, uint8_t *<em>pRspBuf</em>, size_t *<em>pRspBufLen</em><span class="sig-paren">)</span><br /></dt> |
| <dd><p>Get the signature of last executed script. </p> |
| <p>This API will called in case there is tear down</p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>Status of the operation</p> |
| </dd> |
| <dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><span class="pre">pContext</span></code>: Pointer to sems lite agent context.</p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">pRspBuf</span></code>: Pointer to response Buffer.</p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">pRspBufLen</span></code>: Pointer to length of the response Buffer</p></li> |
| </ul> |
| </dd> |
| <dt><strong>Return Value</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><a class="reference internal" href="../../api/enum_fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70.html#fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70abbddf43382dda6bce2ae5fd96fcfc97c"><span class="std std-ref"><span class="pre">kStatus_SSS_Success</span></span></a></code>: The operation has completed successfully.</p></li> |
| <li><p><code class="docutils literal notranslate"><a class="reference internal" href="../../api/enum_fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70.html#fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70a32741fa0bf21fca96d56375fc8f826e2"><span class="std std-ref"><span class="pre">kStatus_SSS_Fail</span></span></a></code>: The operation has failed. </p></li> |
| </ul> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="function"> |
| <dt> |
| <a class="reference internal" href="../../api/enum_fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70.html#_CPPv412sss_status_t" title="sss_status_t">sss_status_t</a> <code class="sig-name descname">sems_lite_get_UUID</code><span class="sig-paren">(</span>sems_lite_agent_ctx_t *<em>pContext</em>, uint8_t *<em>pRspBuf</em>, size_t *<em>pRspBufLen</em><span class="sig-paren">)</span><br /></dt> |
| <dd><p>Retrieve UUID from SE. </p> |
| <p>This API read UUID of the SE.</p> |
| <p><dl class="simple"> |
| <dt><strong>Return</strong></dt><dd><p>Status of the operation</p> |
| </dd> |
| <dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><span class="pre">pContext</span></code>: Pointer to sems lite agent context.</p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">pRspBuf</span></code>: Pointer to response Buffer.</p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">pRspBufLen</span></code>: Pointer to length of the response Buffer.</p></li> |
| </ul> |
| </dd> |
| <dt><strong>Return Value</strong></dt><dd><ul class="breatheparameterlist simple"> |
| <li><p><code class="docutils literal notranslate"><a class="reference internal" href="../../api/enum_fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70.html#fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70abbddf43382dda6bce2ae5fd96fcfc97c"><span class="std std-ref"><span class="pre">kStatus_SSS_Success</span></span></a></code>: The operation has completed successfully.</p></li> |
| <li><p><code class="docutils literal notranslate"><a class="reference internal" href="../../api/enum_fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70.html#fsl__sss__api_8h_1a82a023f4d1bf8b22df395d3bffb0ce70a32741fa0bf21fca96d56375fc8f826e2"><span class="std std-ref"><span class="pre">kStatus_SSS_Fail</span></span></a></code>: The operation has failed. </p></li> |
| </ul> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| </div> |
| <dl class="class"> |
| <dt> |
| <em class="property">struct </em><code class="sig-name descname">multicast_package_t</code><br /></dt> |
| <dd><div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric">Public Members</p> |
| <dl class="member"> |
| <dt> |
| size_t <code class="sig-name descname">multicastCommandsLen</code><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="member"> |
| <dt> |
| size_t <code class="sig-name descname">multicastPackageNameLen</code><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="member"> |
| <dt> |
| uint8_t <code class="sig-name descname">multicastPackageVersion</code>[2]<br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="member"> |
| <dt> |
| <em class="property">const</em> uint8_t *<code class="sig-name descname">pMulticastCommands</code><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="member"> |
| <dt> |
| <em class="property">const</em> char *<code class="sig-name descname">pMulticastPackageName</code><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="member"> |
| <dt> |
| <em class="property">const</em> uint8_t *<code class="sig-name descname">pSignatureOverCommands</code><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="member"> |
| <dt> |
| <em class="property">const</em> <a class="reference internal" href="../../api/structsub__component__meta_data__t.html#_CPPv424sub_component_metaData_t" title="sub_component_metaData_t">sub_component_metaData_t</a> *<code class="sig-name descname">pSubComponentMetaData</code><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="member"> |
| <dt> |
| uint32_t <code class="sig-name descname">requiredFreeBytesNonVolatileMemory</code><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="member"> |
| <dt> |
| uint32_t <code class="sig-name descname">requiredFreeBytesTransientMemory</code><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="member"> |
| <dt> |
| uint32_t <code class="sig-name descname">semsLiteAPIVersion</code><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="member"> |
| <dt> |
| size_t <code class="sig-name descname">signatureOverCommandsLen</code><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="member"> |
| <dt> |
| uint8_t <code class="sig-name descname">target12Nc</code>[6]<br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="member"> |
| <dt> |
| uint8_t <code class="sig-name descname">targetEntityID</code>[16]<br /></dt> |
| <dd></dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt> |
| <em class="property">struct </em><code class="sig-name descname">sems_lite_available_mem_t</code><br /></dt> |
| <dd><div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric">Public Members</p> |
| <dl class="member"> |
| <dt> |
| uint32_t <code class="sig-name descname">availableCODMemory</code><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="member"> |
| <dt> |
| uint32_t <code class="sig-name descname">availableCORMemory</code><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="member"> |
| <dt> |
| uint32_t <code class="sig-name descname">availableIDX</code><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="member"> |
| <dt> |
| uint32_t <code class="sig-name descname">availablePersistentMemory</code><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="member"> |
| <dt> |
| uint32_t <code class="sig-name descname">freePHeapCentralGap</code><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="member"> |
| <dt> |
| uint32_t <code class="sig-name descname">freeTransient</code><br /></dt> |
| <dd></dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt> |
| <em class="property">struct </em><code class="sig-name descname">sems_lite_SEAppInfoList_t</code><br /></dt> |
| <dd><em>#include <sems_lite_api.h></em><p>Information of about Applet/Package</p> |
| <p>See Table 11-36: GlobalPlatform Registry Data (TLV), GPCardSpc_v2.2.pdf</p> |
| <p>The response from Applet is put to rspBuf</p> |
| <p>After parsing that response, the pointers to respective members is set and it points to relevant part in rspBuf, this way saving memory. However, the Length is updated so that application use this information. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric">Public Members</p> |
| <dl class="member"> |
| <dt> |
| uint8_t <code class="sig-name descname">AIDLen</code><br /></dt> |
| <dd><p>Length of the Applet ID </p> |
| </dd></dl> |
| |
| <dl class="member"> |
| <dt> |
| uint8_t <code class="sig-name descname">LifeCycleState</code><br /></dt> |
| <dd><p>Life-cycle state </p> |
| </dd></dl> |
| |
| <dl class="member"> |
| <dt> |
| uint8_t <code class="sig-name descname">LoadFileAIDLen</code><br /></dt> |
| <dd><p>Length of LoadFileAID. </p> |
| </dd></dl> |
| |
| <dl class="member"> |
| <dt> |
| uint8_t <code class="sig-name descname">LoadFileVersionNumberLen</code><br /></dt> |
| <dd><p>Length of pLoadFileVersionNumber. </p> |
| </dd></dl> |
| |
| <dl class="member"> |
| <dt> |
| uint8_t *<code class="sig-name descname">pAID</code><br /></dt> |
| <dd><p>Applet ID </p> |
| </dd></dl> |
| |
| <dl class="member"> |
| <dt> |
| uint8_t *<code class="sig-name descname">pLoadFileAID</code><br /></dt> |
| <dd><p>Application’s Executable Load File AID. </p> |
| </dd></dl> |
| |
| <dl class="member"> |
| <dt> |
| uint8_t *<code class="sig-name descname">pLoadFileVersionNumber</code><br /></dt> |
| <dd><p>Executable Load File Version Number. </p> |
| </dd></dl> |
| |
| <dl class="member"> |
| <dt> |
| uint8_t *<code class="sig-name descname">pPriviledges</code><br /></dt> |
| <dd><p>Privileges. </p> |
| </dd></dl> |
| |
| <dl class="member"> |
| <dt> |
| uint8_t <code class="sig-name descname">PriviledgesLen</code><br /></dt> |
| <dd><p>Length of Privileges </p> |
| </dd></dl> |
| |
| <dl class="member"> |
| <dt> |
| uint8_t *<code class="sig-name descname">pSecurityDomainAID</code><br /></dt> |
| <dd><p>Associated Security Domain’s AID. </p> |
| </dd></dl> |
| |
| <dl class="member"> |
| <dt> |
| uint8_t <code class="sig-name descname">rspBuf</code>[(256 + 5)]<br /></dt> |
| <dd><p>Response from Applet. </p> |
| </dd></dl> |
| |
| <dl class="member"> |
| <dt> |
| size_t <code class="sig-name descname">rspBufLen</code><br /></dt> |
| <dd><p>Length of response from Applet. </p> |
| </dd></dl> |
| |
| <dl class="member"> |
| <dt> |
| uint8_t <code class="sig-name descname">SecurityDomainAIDLen</code><br /></dt> |
| <dd><p>Length of SecurityDomainAID. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt> |
| <em class="property">struct </em><code class="sig-name descname">sub_component_metaData_t</code><br /></dt> |
| <dd><div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric">Public Members</p> |
| <dl class="member"> |
| <dt> |
| size_t <code class="sig-name descname">aidLen</code><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="member"> |
| <dt> |
| uint8_t <code class="sig-name descname">minimumPreviousVersion</code>[2]<br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="member"> |
| <dt> |
| size_t <code class="sig-name descname">nameLen</code><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="member"> |
| <dt> |
| <em class="property">const</em> uint8_t *<code class="sig-name descname">pAid</code><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="member"> |
| <dt> |
| char *<code class="sig-name descname">pName</code><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="member"> |
| <dt> |
| <em class="property">struct</em> _sub_component_metaData_t *<code class="sig-name descname">pNextSubComponentMetaData</code><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="member"> |
| <dt> |
| uint8_t <code class="sig-name descname">version</code>[2]<br /></dt> |
| <dd></dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| </div> |
| |
| |
| </div> |
| |
| </div> |
| </div> |
| <footer class="footer"> |
| <div class="container"> |
| <p class="pull-right"> |
| <a href="#">Back to top</a> |
| |
| </p> |
| <p> |
| © Copyright 2018-2020, NXP.<br/> |
| Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.4.1.<br/> |
| </p> |
| </div> |
| </footer> |
| </body> |
| </html> |
