+- For Secure platforms like PSoC64, MCUBootloader will get programmed during kit provisioning process. + +- Prior to provisioning the PSoC64 kit (CY8CKIT-064B0S2-4343W), User need to create *policies* and *keys* for provisioning. To do this, execute the following 'init' command from application root folder. + ``` + cysecuretools -t CY8CKIT-064B0S2-4343W init + ``` + +- The *init* command creates the *keys*, *packets*, *policy*, and *prebuilt* directories in application root folder. These keys and policies are utilized during the provisioning and OTA image signing process. + +- Copy policy *policy_single_CM0_CM4_smif_swap.json* from [configs folder](./configs/COMPONENT_MCUBOOT/flashmap/) and replace it with the one in *policy* folder which is generated after executing *init* command. + +- Please copy the *policy_single_CM0_CM4_smif_swap.json* file from the [configs folder](./configs/COMPONENT_MCUBOOT/flashmap/) and replace it with the version in the *policy* folder, which will be generated after running the *init* command. + +- The public key is programmed during the provisioning for further image verification. The private key is used to sign the image with the user application. Create a private key using below command. The public part of the key will be taken from the private during provisioning. + ``` + cysecuretools -t CY8CKIT-064B0S2-4343W -p policy/policy_single_CM0_CM4_swap.json create-keys + ``` + +- Provision the kit with policy *policy_single_CM0_CM4_smif_swap.json*. Refer [Provisioning Steps for CY8CKIT-064B0S2-4343W](https://github.com/Infineon/cysecuretools/blob/master/docs/README_PSOC64.md) for complete provisionig steps. + +- During provisioning, the MCU bootloader is also loaded and executed from the CM0 core upon reboot. + + +## 4. Enabling Debug Output + +The *ota-bootloader-abstraction* library disables all debug log messages by default. Do the following to enable log messages: + +1. Add the `ENABLE_OTA_BOOTLOADER_ABSTRACTION_LOGS` macro to the *DEFINES* in the code example's makefile. The makefile entry should look like as follows: + ``` + DEFINES+=ENABLE_OTA_BOOTLOADER_ABSTRACTION_LOGS + ``` + +2. Call the `cy_log_init()` function provided by the *cy-log* module. cy-log is part of the *connectivity-utilities* library. See [connectivity-utilities library API documentation](https://infineon.github.io/connectivity-utilities/api_reference_manual/html/group__logging__utils.html) for cy-log details. + +## 5. Note on Using Windows 10 + +When using ModusToolbox, you will need to install the pip requirements to Python in the ModusToolbox installation. + +``` +\
+ If the automatic redirection is failing, click the following link to open API Reference Manual. +
+ + diff --git a/docs/api_reference_manual/html/bc_s.png b/docs/api_reference_manual/html/bc_s.png new file mode 100644 index 0000000..224b29a Binary files /dev/null and b/docs/api_reference_manual/html/bc_s.png differ diff --git a/docs/api_reference_manual/html/bdwn.png b/docs/api_reference_manual/html/bdwn.png new file mode 100644 index 0000000..940a0b9 Binary files /dev/null and b/docs/api_reference_manual/html/bdwn.png differ diff --git a/docs/api_reference_manual/html/closed.png b/docs/api_reference_manual/html/closed.png new file mode 100644 index 0000000..98cc2c9 Binary files /dev/null and b/docs/api_reference_manual/html/closed.png differ diff --git a/docs/api_reference_manual/html/doxygen.png b/docs/api_reference_manual/html/doxygen.png new file mode 100644 index 0000000..3ff17d8 Binary files /dev/null and b/docs/api_reference_manual/html/doxygen.png differ diff --git a/docs/api_reference_manual/html/doxygen_style.css b/docs/api_reference_manual/html/doxygen_style.css new file mode 100644 index 0000000..75194dd --- /dev/null +++ b/docs/api_reference_manual/html/doxygen_style.css @@ -0,0 +1,1544 @@ +/* The standard CSS for doxygen 1.8.11 */ + +body, table, div, p, dl { + font: 400 14px/22px Roboto,sans-serif; +} + +/* @group Heading Levels */ + +h1.groupheader { + font-size: 150%; +} + +.title { + font: 400 14px/28px Roboto,sans-serif; + font-size: 150%; + font-weight: bold; + margin: 10px 2px; +} + +h2.groupheader { + border-bottom: 1px solid #879ECB; + color: #354C7B; + font-size: 150%; + font-weight: normal; + margin-top: 1.75em; + padding-top: 8px; + padding-bottom: 4px; + width: 100%; +} + +h3.groupheader { + font-size: 100%; +} + +h1, h2, h3, h4, h5, h6 { + -webkit-transition: text-shadow 0.5s linear; + -moz-transition: text-shadow 0.5s linear; + -ms-transition: text-shadow 0.5s linear; + -o-transition: text-shadow 0.5s linear; + transition: text-shadow 0.5s linear; + margin-right: 15px; +} + +h1.glow, h2.glow, h3.glow, h4.glow, h5.glow, h6.glow { + text-shadow: 0 0 15px cyan; +} + +dt { + font-weight: bold; +} + +div.multicol { + -moz-column-gap: 1em; + -webkit-column-gap: 1em; + -moz-column-count: 3; + -webkit-column-count: 3; +} + +p.startli, p.startdd { + margin-top: 2px; +} + +p.starttd { + margin-top: 0px; +} + +p.endli { + margin-bottom: 0px; +} + +p.enddd { + margin-bottom: 4px; +} + +p.endtd { + margin-bottom: 2px; +} + +/* @end */ + +caption { + font-weight: bold; +} + +span.legend { + font-size: 70%; + text-align: center; +} + +h3.version { + font-size: 90%; + text-align: center; +} + +div.qindex, div.navtab{ + background-color: #EBEFF6; + border: 1px solid #A3B4D7; + text-align: center; +} + +div.qindex, div.navpath { + width: 100%; + line-height: 140%; +} + +div.navtab { + margin-right: 15px; +} + +/* @group Link Styling */ + +a { + color: #3D578C; + font-weight: normal; + text-decoration: none; +} + +.contents a:visited { + color: #4665A2; +} + +a:hover { + text-decoration: underline; +} + +a.qindex { + font-weight: bold; +} + +a.qindexHL { + font-weight: bold; + background-color: #9CAFD4; + color: #ffffff; + border: 1px double #869DCA; +} + +.contents a.qindexHL:visited { + color: #ffffff; +} + +a.el { + font-weight: bold; +} + +a.elRef { +} + +a.code, a.code:visited, a.line, a.line:visited { + color: #4665A2; +} + +a.codeRef, a.codeRef:visited, a.lineRef, a.lineRef:visited { + color: #4665A2; +} + +/* @end */ + +dl.el { + margin-left: -1cm; +} + +pre.fragment { + border: 1px solid #C4CFE5; + background-color: #FBFCFD; + padding: 4px 6px; + margin: 4px 8px 4px 2px; + overflow: auto; + word-wrap: break-word; + font-size: 9pt; + line-height: 125%; + font-family: monospace, fixed; + font-size: 105%; +} + +div.fragment { + padding: 4px 6px; + margin: 4px 8px 4px 2px; + background-color: #FBFCFD; + border: 1px solid #C4CFE5; +} + +div.line { + font-family: monospace, fixed; + font-size: 13px; + min-height: 13px; + line-height: 1.0; + text-wrap: unrestricted; + white-space: -moz-pre-wrap; /* Moz */ + white-space: -pre-wrap; /* Opera 4-6 */ + white-space: -o-pre-wrap; /* Opera 7 */ + white-space: pre-wrap; /* CSS3 */ + word-wrap: break-word; /* IE 5.5+ */ + text-indent: -53px; + padding-left: 53px; + padding-bottom: 0px; + margin: 0px; + -webkit-transition-property: background-color, box-shadow; + -webkit-transition-duration: 0.5s; + -moz-transition-property: background-color, box-shadow; + -moz-transition-duration: 0.5s; + -ms-transition-property: background-color, box-shadow; + -ms-transition-duration: 0.5s; + -o-transition-property: background-color, box-shadow; + -o-transition-duration: 0.5s; + transition-property: background-color, box-shadow; + transition-duration: 0.5s; +} + +div.line:after { + content:"\000A"; + white-space: pre; +} + +div.line.glow { + background-color: cyan; + box-shadow: 0 0 10px cyan; +} + + +span.lineno { + padding-right: 4px; + text-align: right; + border-right: 2px solid #0F0; + background-color: #E8E8E8; + white-space: pre; +} +span.lineno a { + background-color: #D8D8D8; +} + +span.lineno a:hover { + background-color: #C8C8C8; +} + +div.ah, span.ah { + background-color: black; + font-weight: bold; + color: #ffffff; + margin-bottom: 3px; + margin-top: 3px; + padding: 0.2em; + border: solid thin #333; + border-radius: 0.5em; + -webkit-border-radius: .5em; + -moz-border-radius: .5em; + box-shadow: 2px 2px 3px #999; + -webkit-box-shadow: 2px 2px 3px #999; + -moz-box-shadow: rgba(0, 0, 0, 0.15) 2px 2px 2px; + background-image: -webkit-gradient(linear, left top, left bottom, from(#eee), to(#000),color-stop(0.3, #444)); + background-image: -moz-linear-gradient(center top, #eee 0%, #444 40%, #000 110%); +} + +div.classindex ul { + list-style: none; + padding-left: 0; +} + +div.classindex span.ai { + display: inline-block; +} + +div.groupHeader { + margin-left: 16px; + margin-top: 12px; + font-weight: bold; +} + +div.groupText { + margin-left: 16px; + font-style: italic; +} + +body { + background-color: white; + color: black; + margin: 0; +} + +div.contents { + margin-top: 10px; + margin-left: 12px; + margin-right: 8px; +} + +td.indexkey { + background-color: #EBEFF6; + font-weight: bold; + border: 1px solid #C4CFE5; + margin: 2px 0px 2px 0; + padding: 2px 10px; + white-space: nowrap; + vertical-align: top; +} + +td.indexvalue { + background-color: #EBEFF6; + border: 1px solid #C4CFE5; + padding: 2px 10px; + margin: 2px 0px; +} + +tr.memlist { + background-color: #EEF1F7; +} + +p.formulaDsp { + text-align: center; +} + +img.formulaDsp { + +} + +img.formulaInl { + vertical-align: middle; +} + +div.center { + text-align: center; + margin-top: 0px; + margin-bottom: 0px; + padding: 0px; +} + +div.center img { + border: 0px; +} + +address.footer { + text-align: right; + padding-right: 12px; +} + +img.footer { + border: 0px; + vertical-align: middle; +} + +/* @group Code Colorization */ + +span.keyword { + color: #008000 +} + +span.keywordtype { + color: #604020 +} + +span.keywordflow { + color: #e08000 +} + +span.comment { + color: #800000 +} + +span.preprocessor { + color: #806020 +} + +span.stringliteral { + color: #002080 +} + +span.charliteral { + color: #008080 +} + +span.vhdldigit { + color: #ff00ff +} + +span.vhdlchar { + color: #000000 +} + +span.vhdlkeyword { + color: #700070 +} + +span.vhdllogic { + color: #ff0000 +} + +blockquote { + background-color: #F7F8FB; + border-left: 2px solid #9CAFD4; + margin: 0 24px 0 4px; + padding: 0 12px 0 16px; +} + +/* @end */ + +/* +.search { + color: #003399; + font-weight: bold; +} + +form.search { + margin-bottom: 0px; + margin-top: 0px; +} + +input.search { + font-size: 75%; + color: #000080; + font-weight: normal; + background-color: #e8eef2; +} +*/ + +td.tiny { + font-size: 75%; +} + +.dirtab { + padding: 4px; + border-collapse: collapse; + border: 1px solid #A3B4D7; +} + +th.dirtab { + background: #EBEFF6; + font-weight: bold; +} + +hr { + height: 0px; + border: none; + border-top: 1px solid #4A6AAA; +} + +hr.footer { + height: 1px; +} + +/* @group Member Descriptions */ + +table.memberdecls { + border-spacing: 0px; + padding: 0px; +} + +.memberdecls td, .fieldtable tr { + -webkit-transition-property: background-color, box-shadow; + -webkit-transition-duration: 0.5s; + -moz-transition-property: background-color, box-shadow; + -moz-transition-duration: 0.5s; + -ms-transition-property: background-color, box-shadow; + -ms-transition-duration: 0.5s; + -o-transition-property: background-color, box-shadow; + -o-transition-duration: 0.5s; + transition-property: background-color, box-shadow; + transition-duration: 0.5s; +} + +.memberdecls td.glow, .fieldtable tr.glow { + background-color: cyan; + box-shadow: 0 0 15px cyan; +} + +.mdescLeft, .mdescRight, +.memItemLeft, .memItemRight, +.memTemplItemLeft, .memTemplItemRight, .memTemplParams { + background-color: #F9FAFC; + border: none; + margin: 4px; + padding: 1px 0 0 8px; +} + +.mdescLeft, .mdescRight { + padding: 0px 8px 4px 8px; + color: #555; +} + +.memSeparator { + border-bottom: 1px solid #DEE4F0; + line-height: 1px; + margin: 0px; + padding: 0px; +} + +.memItemLeft, .memTemplItemLeft { + white-space: nowrap; +} + +.memItemRight { + width: 100%; +} + +.memTemplParams { + color: #4665A2; + white-space: nowrap; + font-size: 80%; +} + +/* @end */ + +/* @group Member Details */ + +/* Styles for detailed member documentation */ + +.memtemplate { + font-size: 80%; + color: #4665A2; + font-weight: normal; + margin-left: 9px; +} + +.memnav { + background-color: #EBEFF6; + border: 1px solid #A3B4D7; + text-align: center; + margin: 2px; + margin-right: 15px; + padding: 2px; +} + +.mempage { + width: 100%; +} + +.memitem { + padding: 0; + margin-bottom: 10px; + margin-right: 5px; + -webkit-transition: box-shadow 0.5s linear; + -moz-transition: box-shadow 0.5s linear; + -ms-transition: box-shadow 0.5s linear; + -o-transition: box-shadow 0.5s linear; + transition: box-shadow 0.5s linear; + display: table !important; + width: 100%; +} + +.memitem.glow { + box-shadow: 0 0 15px cyan; +} + +.memname { + font-weight: bold; + margin-left: 6px; +} + +.memname td { + vertical-align: bottom; +} + +.memproto, dl.reflist dt { + border-top: 1px solid #A8B8D9; + border-left: 1px solid #A8B8D9; + border-right: 1px solid #A8B8D9; + padding: 6px 0px 6px 0px; + color: #253555; + font-weight: bold; + text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9); + background-image:url('nav_f.png'); + background-repeat:repeat-x; + background-color: #E2E8F2; + /* opera specific markup */ + box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); + border-top-right-radius: 4px; + border-top-left-radius: 4px; + /* firefox specific markup */ + -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px; + -moz-border-radius-topright: 4px; + -moz-border-radius-topleft: 4px; + /* webkit specific markup */ + -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); + -webkit-border-top-right-radius: 4px; + -webkit-border-top-left-radius: 4px; + +} + +.memdoc, dl.reflist dd { + border-bottom: 1px solid #A8B8D9; + border-left: 1px solid #A8B8D9; + border-right: 1px solid #A8B8D9; + padding: 6px 10px 2px 10px; + background-color: #FBFCFD; + border-top-width: 0; + background-image:url('nav_g.png'); + background-repeat:repeat-x; + background-color: #FFFFFF; + /* opera specific markup */ + border-bottom-left-radius: 4px; + border-bottom-right-radius: 4px; + box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); + /* firefox specific markup */ + -moz-border-radius-bottomleft: 4px; + -moz-border-radius-bottomright: 4px; + -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px; + /* webkit specific markup */ + -webkit-border-bottom-left-radius: 4px; + -webkit-border-bottom-right-radius: 4px; + -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); +} + +dl.reflist dt { + padding: 5px; +} + +dl.reflist dd { + margin: 0px 0px 10px 0px; + padding: 5px; +} + +.paramkey { + text-align: right; +} + +.paramtype { + white-space: nowrap; +} + +.paramname { + color: #602020; + white-space: nowrap; +} +.paramname em { + font-style: normal; +} +.paramname code { + line-height: 14px; +} + +.params, .retval, .exception, .tparams { + margin-left: 0px; + padding-left: 0px; +} + +.params .paramname, .retval .paramname { + font-weight: bold; + vertical-align: top; +} + +.params .paramtype { + font-style: italic; + vertical-align: top; +} + +.params .paramdir { + font-family: "courier new",courier,monospace; + vertical-align: top; +} + +table.mlabels { + border-spacing: 0px; +} + +td.mlabels-left { + width: 100%; + padding: 0px; +} + +td.mlabels-right { + vertical-align: bottom; + padding: 0px; + white-space: nowrap; +} + +span.mlabels { + margin-left: 8px; +} + +span.mlabel { + background-color: #728DC1; + border-top:1px solid #5373B4; + border-left:1px solid #5373B4; + border-right:1px solid #C4CFE5; + border-bottom:1px solid #C4CFE5; + text-shadow: none; + color: white; + margin-right: 4px; + padding: 2px 3px; + border-radius: 3px; + font-size: 7pt; + white-space: nowrap; + vertical-align: middle; +} + + + +/* @end */ + +/* these are for tree view inside a (index) page */ + +div.directory { + margin: 10px 0px; + border-top: 1px solid #9CAFD4; + border-bottom: 1px solid #9CAFD4; + width: 100%; +} + +.directory table { + border-collapse:collapse; +} + +.directory td { + margin: 0px; + padding: 0px; + vertical-align: top; +} + +.directory td.entry { + white-space: nowrap; + padding-right: 6px; + padding-top: 3px; +} + +.directory td.entry a { + outline:none; +} + +.directory td.entry a img { + border: none; +} + +.directory td.desc { + width: 100%; + padding-left: 6px; + padding-right: 6px; + padding-top: 3px; + border-left: 1px solid rgba(0,0,0,0.05); +} + +.directory tr.even { + padding-left: 6px; + background-color: #F7F8FB; +} + +.directory img { + vertical-align: -30%; +} + +.directory .levels { + white-space: nowrap; + width: 100%; + text-align: right; + font-size: 9pt; +} + +.directory .levels span { + cursor: pointer; + padding-left: 2px; + padding-right: 2px; + color: #3D578C; +} + +.arrow { + color: #9CAFD4; + -webkit-user-select: none; + -khtml-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; + cursor: pointer; + font-size: 80%; + display: inline-block; + width: 16px; + height: 22px; +} + +.icon { + font-family: Arial, Helvetica; + font-weight: bold; + font-size: 12px; + height: 14px; + width: 16px; + display: inline-block; + background-color: #728DC1; + color: white; + text-align: center; + border-radius: 4px; + margin-left: 2px; + margin-right: 2px; +} + +.icona { + width: 24px; + height: 22px; + display: inline-block; +} + +.iconfopen { + width: 24px; + height: 18px; + margin-bottom: 4px; + background-image:url('folderopen.png'); + background-position: 0px -4px; + background-repeat: repeat-y; + vertical-align:top; + display: inline-block; +} + +.iconfclosed { + width: 24px; + height: 18px; + margin-bottom: 4px; + background-image:url('folderclosed.png'); + background-position: 0px -4px; + background-repeat: repeat-y; + vertical-align:top; + display: inline-block; +} + +.icondoc { + width: 24px; + height: 18px; + margin-bottom: 4px; + background-image:url('doc.png'); + background-position: 0px -4px; + background-repeat: repeat-y; + vertical-align:top; + display: inline-block; +} + +table.directory { + font: 400 14px Roboto,sans-serif; +} + +/* @end */ + +div.dynheader { + margin-top: 8px; + -webkit-touch-callout: none; + -webkit-user-select: none; + -khtml-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; +} + +address { + font-style: normal; + color: #2A3D61; +} + +table.doxtable caption { + caption-side: top; +} + +table.doxtable { + border-collapse:collapse; + margin-top: 4px; + margin-bottom: 4px; +} + +table.doxtable td, table.doxtable th { + border: 1px solid #2D4068; + padding: 3px 7px 2px; +} + +table.doxtable th { + background-color: #A8A8A8; + color: #000; + font-size: 110%; + padding-bottom: 4px; + padding-top: 5px; +} + +table.fieldtable { + /*width: 100%;*/ + margin-bottom: 10px; + border: 1px solid #A8B8D9; + border-spacing: 0px; + -moz-border-radius: 4px; + -webkit-border-radius: 4px; + border-radius: 4px; + -moz-box-shadow: rgba(0, 0, 0, 0.15) 2px 2px 2px; + -webkit-box-shadow: 2px 2px 2px rgba(0, 0, 0, 0.15); + box-shadow: 2px 2px 2px rgba(0, 0, 0, 0.15); +} + +.fieldtable td, .fieldtable th { + padding: 3px 7px 2px; +} + +.fieldtable td.fieldtype, .fieldtable td.fieldname { + white-space: nowrap; + border-right: 1px solid #A8B8D9; + border-bottom: 1px solid #A8B8D9; + vertical-align: top; +} + +.fieldtable td.fieldname { + padding-top: 3px; +} + +.fieldtable td.fielddoc { + border-bottom: 1px solid #A8B8D9; + /*width: 100%;*/ +} + +.fieldtable td.fielddoc p:first-child { + margin-top: 0px; +} + +.fieldtable td.fielddoc p:last-child { + margin-bottom: 2px; +} + +.fieldtable tr:last-child td { + border-bottom: none; +} + +.fieldtable th { + background-image:url('nav_f.png'); + background-repeat:repeat-x; + background-color: #E2E8F2; + font-size: 90%; + color: #253555; + padding-bottom: 4px; + padding-top: 5px; + text-align:left; + -moz-border-radius-topleft: 4px; + -moz-border-radius-topright: 4px; + -webkit-border-top-left-radius: 4px; + -webkit-border-top-right-radius: 4px; + border-top-left-radius: 4px; + border-top-right-radius: 4px; + border-bottom: 1px solid #A8B8D9; +} + + +.tabsearch { + top: 0px; + left: 10px; + height: 36px; + background-image: url('tab_b.png'); + z-index: 101; + overflow: hidden; + font-size: 13px; +} + +.navpath ul +{ + font-size: 11px; + background-image:url('tab_b.png'); + background-repeat:repeat-x; + background-position: 0 -5px; + height:30px; + line-height:30px; + color:#8AA0CC; + border:solid 1px #C2CDE4; + overflow:hidden; + margin:0px; + padding:0px; +} + +.navpath li +{ + list-style-type:none; + float:left; + padding-left:10px; + padding-right:15px; + background-image:url('bc_s.png'); + background-repeat:no-repeat; + background-position:right; + color:#364D7C; +} + +.navpath li.navelem a +{ + height:32px; + display:block; + text-decoration: none; + outline: none; + color: #283A5D; + font-family: 'Lucida Grande',Geneva,Helvetica,Arial,sans-serif; + text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9); + text-decoration: none; +} + +.navpath li.navelem a:hover +{ + color:#6884BD; +} + +.navpath li.footer +{ + list-style-type:none; + float:right; + padding-left:10px; + padding-right:15px; + background-image:none; + background-repeat:no-repeat; + background-position:right; + color:#364D7C; + font-size: 8pt; +} + + +div.summary +{ + float: right; + font-size: 8pt; + padding-right: 5px; + width: 50%; + text-align: right; +} + +div.summary a +{ + white-space: nowrap; +} + +table.classindex +{ + margin: 10px; + white-space: nowrap; + margin-left: 3%; + margin-right: 3%; + width: 94%; + border: 0; + border-spacing: 0; + padding: 0; +} + +div.ingroups +{ + font-size: 8pt; + width: 50%; + text-align: left; +} + +div.ingroups a +{ + white-space: nowrap; +} + +div.header +{ + background-image:url('nav_h.png'); + background-repeat:repeat-x; + background-color: #F9FAFC; + margin: 0px; + border-bottom: 1px solid #C4CFE5; +} + +div.headertitle +{ + padding: 5px 5px 5px 10px; +} + +dl +{ + padding: 0 0 0 10px; +} + +/* dl.note, dl.warning, dl.attention, dl.pre, dl.post, dl.invariant, dl.deprecated, dl.todo, dl.test, dl.bug */ +dl.section +{ + margin-left: 0px; + padding-left: 0px; +} + +dl.note +{ + margin-left:-7px; + padding-left: 3px; + border-left:4px solid; + border-color: #D0C000; +} + +dl.warning, dl.attention +{ + margin-left:-7px; + padding-left: 3px; + border-left:4px solid; + border-color: #FF0000; +} + +dl.pre, dl.post, dl.invariant +{ + margin-left:-7px; + padding-left: 3px; + border-left:4px solid; + border-color: #00D000; +} + +dl.deprecated +{ + margin-left:-7px; + padding-left: 3px; + border-left:4px solid; + border-color: #505050; +} + +dl.todo +{ + margin-left:-7px; + padding-left: 3px; + border-left:4px solid; + border-color: #00C0E0; +} + +dl.test +{ + margin-left:-7px; + padding-left: 3px; + border-left:4px solid; + border-color: #3030E0; +} + +dl.bug +{ + margin-left:-7px; + padding-left: 3px; + border-left:4px solid; + border-color: #C08050; +} + +dl.section dd { + margin-bottom: 6px; +} + + +#projectlogo +{ + text-align: center; + vertical-align: bottom; + border-collapse: separate; +} + +#projectlogo img +{ + border: 0px none; +} + +#projectalign +{ + vertical-align: middle; +} + +#projectname +{ + font: 250% sans-serif, Tahoma, Ariel; + margin: 0px; + padding: 2px 0px 2px 25px; +} + +#projectbrief +{ + font: 120% Tahoma, Arial,sans-serif; + color: grey; + margin: 0 0 0 26px; + padding: 0; + + height: 0px; +} + +#projectnumber +{ + font: 40% sans-serif, Tahoma, Ariel; + color: #606060; +} + +#titlearea +{ + padding: 0px; + margin: 0px; + width: 100%; + border-bottom: 1px solid #5373B4; +} + +.image +{ + text-align: center; +} + +.dotgraph +{ + text-align: center; +} + +.mscgraph +{ + text-align: center; +} + +.diagraph +{ + text-align: center; +} + +.caption +{ + font-weight: bold; +} + +div.zoom +{ + border: 1px solid #90A5CE; +} + +dl.citelist { + margin-bottom:50px; +} + +dl.citelist dt { + color:#334975; + float:left; + font-weight:bold; + margin-right:10px; + padding:5px; +} + +dl.citelist dd { + margin:2px 0; + padding:5px 0; +} + +div.toc { + padding: 14px 25px; + background-color: #F4F6FA; + border: 1px solid #D8DFEE; + border-radius: 7px 7px 7px 7px; + float: right; + height: auto; + margin: 0 8px 10px 10px; + width: 200px; +} + +div.toc li { + background: url("bdwn.png") no-repeat scroll 0 5px transparent; + font: 10px/1.2 Verdana,DejaVu Sans,Geneva,sans-serif; + margin-top: 5px; + padding-left: 10px; + padding-top: 2px; +} + +div.toc h3 { + font: bold 12px/1.2 Arial,FreeSans,sans-serif; + color: #4665A2; + border-bottom: 0 none; + margin: 0; +} + +div.toc ul { + list-style: none outside none; + border: medium none; + padding: 0px; +} + +div.toc li.level1 { + margin-left: 0px; +} + +div.toc li.level2 { + margin-left: 15px; +} + +div.toc li.level3 { + margin-left: 30px; +} + +div.toc li.level4 { + margin-left: 45px; +} + +.inherit_header { + font-weight: bold; + color: gray; + cursor: pointer; + -webkit-touch-callout: none; + -webkit-user-select: none; + -khtml-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; +} + +.inherit_header td { + padding: 6px 0px 2px 5px; +} + +.inherit { + display: none; +} + +tr.heading h2 { + margin-top: 12px; + margin-bottom: 4px; +} + +/* tooltip related style info */ + +.ttc { + position: absolute; + display: none; +} + +#powerTip { + cursor: default; + white-space: nowrap; + background-color: white; + border: 1px solid gray; + border-radius: 4px 4px 4px 4px; + box-shadow: 1px 1px 7px gray; + display: none; + font-size: smaller; + max-width: 80%; + opacity: 0.9; + padding: 1ex 1em 1em; + position: absolute; + z-index: 2147483647; +} + +#powerTip div.ttdoc { + color: grey; + font-style: italic; +} + +#powerTip div.ttname a { + font-weight: bold; +} + +#powerTip div.ttname { + font-weight: bold; +} + +#powerTip div.ttdeci { + color: #006318; +} + +#powerTip div { + margin: 0px; + padding: 0px; + font: 12px/16px Roboto,sans-serif; +} + +#powerTip:before, #powerTip:after { + content: ""; + position: absolute; + margin: 0px; +} + +#powerTip.n:after, #powerTip.n:before, +#powerTip.s:after, #powerTip.s:before, +#powerTip.w:after, #powerTip.w:before, +#powerTip.e:after, #powerTip.e:before, +#powerTip.ne:after, #powerTip.ne:before, +#powerTip.se:after, #powerTip.se:before, +#powerTip.nw:after, #powerTip.nw:before, +#powerTip.sw:after, #powerTip.sw:before { + border: solid transparent; + content: " "; + height: 0; + width: 0; + position: absolute; +} + +#powerTip.n:after, #powerTip.s:after, +#powerTip.w:after, #powerTip.e:after, +#powerTip.nw:after, #powerTip.ne:after, +#powerTip.sw:after, #powerTip.se:after { + border-color: rgba(255, 255, 255, 0); +} + +#powerTip.n:before, #powerTip.s:before, +#powerTip.w:before, #powerTip.e:before, +#powerTip.nw:before, #powerTip.ne:before, +#powerTip.sw:before, #powerTip.se:before { + border-color: rgba(128, 128, 128, 0); +} + +#powerTip.n:after, #powerTip.n:before, +#powerTip.ne:after, #powerTip.ne:before, +#powerTip.nw:after, #powerTip.nw:before { + top: 100%; +} + +#powerTip.n:after, #powerTip.ne:after, #powerTip.nw:after { + border-top-color: #ffffff; + border-width: 10px; + margin: 0px -10px; +} +#powerTip.n:before { + border-top-color: #808080; + border-width: 11px; + margin: 0px -11px; +} +#powerTip.n:after, #powerTip.n:before { + left: 50%; +} + +#powerTip.nw:after, #powerTip.nw:before { + right: 14px; +} + +#powerTip.ne:after, #powerTip.ne:before { + left: 14px; +} + +#powerTip.s:after, #powerTip.s:before, +#powerTip.se:after, #powerTip.se:before, +#powerTip.sw:after, #powerTip.sw:before { + bottom: 100%; +} + +#powerTip.s:after, #powerTip.se:after, #powerTip.sw:after { + border-bottom-color: #ffffff; + border-width: 10px; + margin: 0px -10px; +} + +#powerTip.s:before, #powerTip.se:before, #powerTip.sw:before { + border-bottom-color: #808080; + border-width: 11px; + margin: 0px -11px; +} + +#powerTip.s:after, #powerTip.s:before { + left: 50%; +} + +#powerTip.sw:after, #powerTip.sw:before { + right: 14px; +} + +#powerTip.se:after, #powerTip.se:before { + left: 14px; +} + +#powerTip.e:after, #powerTip.e:before { + left: 100%; +} +#powerTip.e:after { + border-left-color: #ffffff; + border-width: 10px; + top: 50%; + margin-top: -10px; +} +#powerTip.e:before { + border-left-color: #808080; + border-width: 11px; + top: 50%; + margin-top: -11px; +} + +#powerTip.w:after, #powerTip.w:before { + right: 100%; +} +#powerTip.w:after { + border-right-color: #ffffff; + border-width: 10px; + top: 50%; + margin-top: -10px; +} +#powerTip.w:before { + border-right-color: #808080; + border-width: 11px; + top: 50%; + margin-top: -11px; +} + +@media print +{ + #top { display: none; } + #side-nav { display: none; } + #nav-path { display: none; } + body { overflow:visible; } + h1, h2, h3, h4, h5, h6 { page-break-after: avoid; } + .summary { display: none; } + .memitem { page-break-inside: avoid; } + #doc-content + { + margin-left:0 !important; + height:auto !important; + width:auto !important; + overflow:inherit; + display:inline; + } +} + + +/* ****************************************************/ + +/* + +#navrow1 +{ + display: none; +} + +*/ + +/* cypress logo */ +img[src="infineon_logo.png"]{ + height:75px; + /*float: right;*/ +} + +/* \section format */ +h1 +{ + border-bottom: 1px solid #879ECB; + color: #354C7B; + font-size: 150%; + font-weight: bold; + margin-top: 1.75em; + padding-top: 8px; + padding-bottom: 4px; + width: 100%; +} + +/* \subsection format */ +h2 +{ + color: #354C7B; + font-size: 150%; + font-weight: normal; + margin-top: 1.0em; + padding-top: 4px; + width: 100%; +} + +/* \ssububsection format */ +h3 +{ + color: #354C7B; + font-size: 100%; + font-weight: bold; + margin-top: 1.0em; + padding-top: 4px; + width: 100%; +} + +/* \snippet_begin */ +pre.snippet_code +{ + font: 100% Consolas, Courier New; + border: 1px solid black; + border-radius: 0.5em; + -webkit-border-radius: 0.5em; + -moz-border-radius: 0.5em; + box-shadow: 2px 2px 3px #999; + -webkit-box-shadow: 2px 2px 3px #999; + -moz-box-shadow: rgba(0, 0, 0, 0.15) 2px 2px 2px; + padding: 8px; + margin: 0px 0px 0px -12px; +} diff --git a/docs/api_reference_manual/html/dynsections.js b/docs/api_reference_manual/html/dynsections.js new file mode 100644 index 0000000..9d6f320 --- /dev/null +++ b/docs/api_reference_manual/html/dynsections.js @@ -0,0 +1,96 @@ +function toggleVisibility(linkObj) +{ + var base = $(linkObj).attr('id'); + var summary = $('#'+base+'-summary'); + var content = $('#'+base+'-content'); + var trigger = $('#'+base+'-trigger'); + var src=$(trigger).attr('src'); + if (content.is(':visible')===true) { + content.hide(); + summary.show(); + $(linkObj).addClass('closed').removeClass('opened'); + $(trigger).attr('src',src.substring(0,src.length-8)+'closed.png'); + } else { + content.show(); + summary.hide(); + $(linkObj).removeClass('closed').addClass('opened'); + $(trigger).attr('src',src.substring(0,src.length-10)+'open.png'); + } + return false; +} + +function updateStripes() +{ + $('table.directory tr'). + removeClass('even').filter(':visible:even').addClass('even'); +} + +function toggleLevel(level) +{ + $('table.directory tr').each(function() { + var l = this.id.split('_').length-1; + var i = $('#img'+this.id.substring(3)); + var a = $('#arr'+this.id.substring(3)); + if (l
+
+
+
+
+
+
+
+
+
+
+
+  |
+
+ Over The Air (OTA) Bootloader Abstraction Library
+ |
+
+
+-
+
- Home +
- API Reference +
-
+ + ++
+
+
+ 
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/api_reference_manual/html/group__group__ota__bootsupport.js b/docs/api_reference_manual/html/group__group__ota__bootsupport.js
new file mode 100644
index 0000000..1d6d7ff
--- /dev/null
+++ b/docs/api_reference_manual/html/group__group__ota__bootsupport.js
@@ -0,0 +1,6 @@
+var group__group__ota__bootsupport =
+[
+ [ "OTA Bootloader Support Macros", "group__group__ota__bootsupport__macros.html", "group__group__ota__bootsupport__macros" ],
+ [ "Bootloader Support Typedefs", "group__group__ota__bootsupport__typedefs.html", "group__group__ota__bootsupport__typedefs" ],
+ [ "Bootloader Support Functions", "group__group__ota__bootsupport__functions.html", "group__group__ota__bootsupport__functions" ]
+];
\ No newline at end of file
diff --git a/docs/api_reference_manual/html/group__group__ota__bootsupport__functions.html b/docs/api_reference_manual/html/group__group__ota__bootsupport__functions.html
new file mode 100644
index 0000000..a82d219
--- /dev/null
+++ b/docs/api_reference_manual/html/group__group__ota__bootsupport__functions.html
@@ -0,0 +1,640 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Infineon OTA Bootloader Support API
+
+
+
+General Description
+OTA Bootloader support for handling and installing firmware updates.
++API Reference | |
| OTA Bootloader Support Macros | |
| Macros used to define the OTA Bootloader Support behavior. | |
| Bootloader Support Typedefs | |
| Typedefs used by the OTA Bootloader Support. | |
| Bootloader Support Functions | |
| Functions for handling and installing firmware updates. | |
+
+
+
+
+
+
+
+
+
+
+
+ |
+
+ Over The Air (OTA) Bootloader Abstraction Library
+ |
+
+
+-
+
- Home +
- API Reference +
-
+ + ++
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/api_reference_manual/html/group__group__ota__bootsupport__functions.js b/docs/api_reference_manual/html/group__group__ota__bootsupport__functions.js
new file mode 100644
index 0000000..91bea24
--- /dev/null
+++ b/docs/api_reference_manual/html/group__group__ota__bootsupport__functions.js
@@ -0,0 +1,17 @@
+var group__group__ota__bootsupport__functions =
+[
+ [ "cy_ota_mem_init", "group__group__ota__bootsupport__functions.html#ga8992438c302b7b07295524c1ff9a1103", null ],
+ [ "cy_ota_mem_read", "group__group__ota__bootsupport__functions.html#gaee479d591db0b2861504f1753fac752d", null ],
+ [ "cy_ota_mem_write", "group__group__ota__bootsupport__functions.html#ga9faaf895a1256d1406c9727e8f3cf991", null ],
+ [ "cy_ota_mem_erase", "group__group__ota__bootsupport__functions.html#gaff6ed4e415f3d05be3266208316daf86", null ],
+ [ "cy_ota_mem_get_prog_size", "group__group__ota__bootsupport__functions.html#gac32ab4f247a4d4cee8a65ee9ce38e0d5", null ],
+ [ "cy_ota_mem_get_erase_size", "group__group__ota__bootsupport__functions.html#ga9acc08068e0389f280ee19a67b84a7d6", null ],
+ [ "cy_ota_storage_init", "group__group__ota__bootsupport__functions.html#gad1e6294598ad971d3cb35eb789ea4b7b", null ],
+ [ "cy_ota_storage_open", "group__group__ota__bootsupport__functions.html#gade56090dfaf908e2aa14a35d1ace6b06", null ],
+ [ "cy_ota_storage_read", "group__group__ota__bootsupport__functions.html#gae935166cb14ce63a64e6f58bafe1c2af", null ],
+ [ "cy_ota_storage_write", "group__group__ota__bootsupport__functions.html#ga2636ed026fa43484ae0f24e74c6bc472", null ],
+ [ "cy_ota_storage_close", "group__group__ota__bootsupport__functions.html#ga7148e14b70eec5343c693dc92147e257", null ],
+ [ "cy_ota_storage_verify", "group__group__ota__bootsupport__functions.html#gafec15fe9e456d05c41e5e8803d18193d", null ],
+ [ "cy_ota_storage_image_validate", "group__group__ota__bootsupport__functions.html#ga5afcd58a2720b61217def6d2fd86cf7f", null ],
+ [ "cy_ota_storage_get_app_info", "group__group__ota__bootsupport__functions.html#gac4a3664a8d4f9e33e3bcc877e78f84f8", null ]
+];
\ No newline at end of file
diff --git a/docs/api_reference_manual/html/group__group__ota__bootsupport__macros.html b/docs/api_reference_manual/html/group__group__ota__bootsupport__macros.html
new file mode 100644
index 0000000..d67b668
--- /dev/null
+++ b/docs/api_reference_manual/html/group__group__ota__bootsupport__macros.html
@@ -0,0 +1,161 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Bootloader Support Functions
+
+
+
+General Description
+Functions for handling and installing firmware updates.
+Bootloader based storage interface APIs for handling downloaded UPGRADE image of OTA application.
+OTA Bootloader support library flash operation APIs.
+Storage Interface APIs call these flash operation APIs to store downloaded UPGRADE image on Internal or External Flash based on target platforms.
+These callbacks are defind in ota-update library and expected to register these callbacks during OTA agent start. ota-bootloader-abstraction library has implementation of these bootloader specific storage interface APIs.
++Functions | |
| cy_rslt_t | cy_ota_mem_init (void) |
| Initializes flash, QSPI flash, or any other external memory type. More... | |
| cy_rslt_t | cy_ota_mem_read (cy_ota_mem_type_t mem_type, uint32_t addr, void *data, size_t len) |
| Read from flash, QSPI flash, or any other external memory type. More... | |
| cy_rslt_t | cy_ota_mem_write (cy_ota_mem_type_t mem_type, uint32_t addr, void *data, size_t len) |
| Write to flash, QSPI flash, or any other external memory type. More... | |
| cy_rslt_t | cy_ota_mem_erase (cy_ota_mem_type_t mem_type, uint32_t addr, size_t len) |
| Erase flash, QSPI flash, or any other external memory type. More... | |
| size_t | cy_ota_mem_get_prog_size (cy_ota_mem_type_t mem_type, uint32_t addr) |
| To get page size for programming flash, QSPI flash, or any other external memory type. More... | |
| size_t | cy_ota_mem_get_erase_size (cy_ota_mem_type_t mem_type, uint32_t addr) |
| To get sector size of flash, QSPI flash, or any other external memory type. More... | |
| cy_rslt_t | cy_ota_storage_init (void) |
| Initialize Storage area. More... | |
| cy_rslt_t | cy_ota_storage_open (cy_ota_storage_context_t *storage_ptr) |
| Open storage area for storing OTA UPGRADE images. More... | |
| cy_rslt_t | cy_ota_storage_read (cy_ota_storage_context_t *storage_ptr, cy_ota_storage_read_info_t *chunk_info) |
| Read data from storage area. More... | |
| cy_rslt_t | cy_ota_storage_write (cy_ota_storage_context_t *storage_ptr, cy_ota_storage_write_info_t *chunk_info) |
| Write data to configured storage area. More... | |
| cy_rslt_t | cy_ota_storage_close (cy_ota_storage_context_t *storage_ptr) |
| Close Storage area for download. More... | |
| cy_rslt_t | cy_ota_storage_verify (cy_ota_storage_context_t *storage_ptr) |
| Verify downloaded UPGRADE OTA image. More... | |
| cy_rslt_t | cy_ota_storage_image_validate (uint16_t app_id) |
| Application has validated the new OTA Image. More... | |
| cy_rslt_t | cy_ota_storage_get_app_info (void *file_des, cy_ota_app_info_t *app_info) |
| Get Application image information. More... | |
Function Documentation
+ +
+
+
+
+
+
+
| cy_rslt_t cy_ota_mem_init | +( | +void | +) | ++ |
+
+
+Initializes flash, QSPI flash, or any other external memory type.
+NOTE: This function must be implemented in the user's code.
+- Returns
- CY_RSLT_SUCCESS on success CY_RSLT_TYPE_ERROR on failure
+
+
+
+
+
+
| cy_rslt_t cy_ota_mem_read | +( | +cy_ota_mem_type_t | +mem_type, | +
| + | + | uint32_t | +addr, | +
| + | + | void * | +data, | +
| + | + | size_t | +len | +
| + | ) | ++ |
+
+
+Read from flash, QSPI flash, or any other external memory type.
+NOTE: This function must be implemented in the user's code.
+- Parameters
-
+
+
+[in] mem_type Memory type cy_ota_mem_type_t [in] addr Starting address to read from. [out] data Pointer to the buffer to store the data read from the memory. [in] len Number of data bytes to read.
+
- Returns
- CY_RSLT_SUCCESS on success CY_RSLT_TYPE_ERROR on failure
+
+
+
+
+
+
| cy_rslt_t cy_ota_mem_write | +( | +cy_ota_mem_type_t | +mem_type, | +
| + | + | uint32_t | +addr, | +
| + | + | void * | +data, | +
| + | + | size_t | +len | +
| + | ) | ++ |
+
+
+Write to flash, QSPI flash, or any other external memory type.
+NOTE: This function must be implemented in the user's code.
+- Parameters
-
+
+
+[in] mem_type Memory type cy_ota_mem_type_t [in] addr Starting address to write to. [in] data Pointer to the buffer containing the data to be written. [in] len Number of bytes to write.
+
- Returns
- CY_RSLT_SUCCESS on success CY_RSLT_TYPE_ERROR on failure
+
+
+
+
+
+
| cy_rslt_t cy_ota_mem_erase | +( | +cy_ota_mem_type_t | +mem_type, | +
| + | + | uint32_t | +addr, | +
| + | + | size_t | +len | +
| + | ) | ++ |
+
+
+Erase flash, QSPI flash, or any other external memory type.
+NOTE: This function must be implemented in the user's code.
+- Parameters
-
+
+
+[in] mem_type Memory type cy_ota_mem_type_t [in] addr Starting address to begin erasing. [in] len Number of bytes to erase.
+
- Returns
- CY_RSLT_SUCCESS CY_RSLT_TYPE_ERROR
+
+
+
+
+
+
| size_t cy_ota_mem_get_prog_size | +( | +cy_ota_mem_type_t | +mem_type, | +
| + | + | uint32_t | +addr | +
| + | ) | ++ |
+
+
+To get page size for programming flash, QSPI flash, or any other external memory type.
+NOTE: This function must be implemented in the user's code.
+- Parameters
-
+
+
+[in] mem_type Memory type cy_ota_mem_type_t [in] addr Address that belongs to the sector for which programming page size needs to be returned.
+
- Returns
- Page size in bytes.
+
+
+
+
+
+
| size_t cy_ota_mem_get_erase_size | +( | +cy_ota_mem_type_t | +mem_type, | +
| + | + | uint32_t | +addr | +
| + | ) | ++ |
+
+
+To get sector size of flash, QSPI flash, or any other external memory type.
+NOTE: This function must be implemented in the user's code.
+- Parameters
-
+
+
+[in] mem_type Memory type cy_ota_mem_type_t [in] addr Address that belongs to the sector for which sector erase size needs to be returned.
+
- Returns
- Sector size in bytes.
+
+
+
+
+
+
| cy_rslt_t cy_ota_storage_init | +( | +void | +) | ++ |
+
+
+Initialize Storage area.
+NOTE: Typically, this initializes flash hardware and Application is expected to call this API once before any other flash operation.
+- Returns
- CY_RSLT_SUCCESS CY_RSLT_TYPE_ERROR
+
+
+
+
+
+
| cy_rslt_t cy_ota_storage_open | +( | +cy_ota_storage_context_t * | +storage_ptr | ) | ++ |
+
+
+Open storage area for storing OTA UPGRADE images.
+NOTE: Typically, This erases UPGRADE Slots.
+- Parameters
-
+
+
+[in] storage_ptr Pointer to the OTA Agent storage context 'cy_ota_storage_context_t'
+
- Returns
- CY_RSLT_SUCCESS CY_RSLT_OTA_ERROR_OPEN_STORAGE
+
+
+
+
+
+
| cy_rslt_t cy_ota_storage_read | +( | +cy_ota_storage_context_t * | +storage_ptr, | +
| + | + | cy_ota_storage_read_info_t * | +chunk_info | +
| + | ) | ++ |
+
+
+Read data from storage area.
+- Parameters
-
+
+
+[in] storage_ptr Pointer to the OTA Agent storage context 'cy_ota_storage_context_t' [in] chunk_info Pointer to read chunk information, buffer pointer used for the read
+
- Returns
- CY_RSLT_SUCCESS CY_RSLT_OTA_ERROR_READ_STORAGE
+
+
+
+
+
+
| cy_rslt_t cy_ota_storage_write | +( | +cy_ota_storage_context_t * | +storage_ptr, | +
| + | + | cy_ota_storage_write_info_t * | +chunk_info | +
| + | ) | ++ |
+
+
+Write data to configured storage area.
+- Parameters
-
+
+
+[in] storage_ptr Pointer to the OTA Agent storage context 'cy_ota_storage_context_t' [in] chunk_info Pointer to write data chunk information
+
- Returns
- CY_UNTAR_SUCCESS CY_UNTAR_ERROR
+
+
+
+
+
+
| cy_rslt_t cy_ota_storage_close | +( | +cy_ota_storage_context_t * | +storage_ptr | ) | ++ |
+
+
+Close Storage area for download.
+- Parameters
-
+
+
+[in] storage_ptr Pointer to the OTA Agent storage context 'cy_ota_storage_context_t'
+
- Returns
- CY_RSLT_SUCCESS CY_RSLT_OTA_ERROR_CLOSE_STORAGE
+
+
+
+
+
+
| cy_rslt_t cy_ota_storage_verify | +( | +cy_ota_storage_context_t * | +storage_ptr | ) | ++ |
+
+
+Verify downloaded UPGRADE OTA image.
+- Parameters
-
+
+
+[in] storage_ptr Pointer to the OTA Agent storage context 'cy_ota_storage_context_t'
+
- Returns
- CY_RSLT_SUCCESS CY_RSLT_OTA_ERROR_GENERAL
+
+
+
+
+
+
| cy_rslt_t cy_ota_storage_image_validate | +( | +uint16_t | +app_id | ) | ++ |
+
+
+Application has validated the new OTA Image.
+This call needs to be after reboot and Bootloader has started the upgrade version of Application. to the Primary Slot.
+- Parameters
-
+
+
+[in] app_id Application ID.
+
- Returns
- CY_RSLT_SUCCESS CY_RSLT_OTA_ERROR_GENERAL
+
+
+
+
+
| cy_rslt_t cy_ota_storage_get_app_info | +( | +void * | +file_des, | +
| + | + | cy_ota_app_info_t * | +app_info | +
| + | ) | ++ |
+
+
+Get Application image information.
+This call needs to be after reboot and Bootloader has started the upgrade version of Application. to the Primary Slot.
+- Parameters
-
+
+
+[in] file_des Pointer to the storage context. [in] app_info Pointer to the OTA Application information structure.
+
- Returns
- CY_RSLT_SUCCESS CY_RSLT_OTA_ERROR_GENERAL
+
+
+
+
+
+
+
+
+
+
+
+ |
+
+ Over The Air (OTA) Bootloader Abstraction Library
+ |
+
+
+-
+
- Home +
- API Reference +
-
+ + ++
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/api_reference_manual/html/group__group__ota__bootsupport__macros.js b/docs/api_reference_manual/html/group__group__ota__bootsupport__macros.js
new file mode 100644
index 0000000..4ae8263
--- /dev/null
+++ b/docs/api_reference_manual/html/group__group__ota__bootsupport__macros.js
@@ -0,0 +1,9 @@
+var group__group__ota__bootsupport__macros =
+[
+ [ "CY_RSLT_SERIAL_FLASH_ERR_UNSUPPORTED", "group__group__ota__bootsupport__macros.html#gabe7c8c3af5cdc0f9640b70402f543dd7", null ],
+ [ "CY_RSLT_SERIAL_FLASH_ERR_NOT_INITED", "group__group__ota__bootsupport__macros.html#ga0d92d6f94defc5de93d6ff25a9c5c922", null ],
+ [ "CY_RSLT_SERIAL_FLASH_ERR_BAD_PARAM", "group__group__ota__bootsupport__macros.html#ga21e3c8199504eb76df66c793488e01e8", null ],
+ [ "CY_RSLT_SERIAL_FLASH_ERR_READ_BUSY", "group__group__ota__bootsupport__macros.html#ga41875c99fa454d69ec187e772234ce44", null ],
+ [ "CY_RSLT_SERIAL_FLASH_ERR_DMA", "group__group__ota__bootsupport__macros.html#ga63374cfb508c830f53f25682c183b610", null ],
+ [ "CY_RSLT_SERIAL_FLASH_ERR_QSPI_BUSY", "group__group__ota__bootsupport__macros.html#ga959a08da14d528096cf8ebbfb48c5da4", null ]
+];
\ No newline at end of file
diff --git a/docs/api_reference_manual/html/group__group__ota__bootsupport__typedefs.html b/docs/api_reference_manual/html/group__group__ota__bootsupport__typedefs.html
new file mode 100644
index 0000000..3881025
--- /dev/null
+++ b/docs/api_reference_manual/html/group__group__ota__bootsupport__typedefs.html
@@ -0,0 +1,163 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+OTA Bootloader Support Macros
+
+
+
+General Description
+Macros used to define the OTA Bootloader Support behavior.
++Macros | |
| +#define | CY_RSLT_SERIAL_FLASH_ERR_UNSUPPORTED (cy_rslt_t)(CY_RSLT_CREATE(CY_RSLT_TYPE_ERROR, CY_RSLT_MODULE_BOARD_LIB_SERIAL_FLASH, 1)) |
| The function or operation is not supported on the target or the memory. | |
| +#define | CY_RSLT_SERIAL_FLASH_ERR_NOT_INITED (cy_rslt_t)(CY_RSLT_CREATE(CY_RSLT_TYPE_ERROR, CY_RSLT_MODULE_BOARD_LIB_SERIAL_FLASH, 2)) |
| The Serial Flash not initialized. | |
| +#define | CY_RSLT_SERIAL_FLASH_ERR_BAD_PARAM (cy_rslt_t)(CY_RSLT_CREATE(CY_RSLT_TYPE_ERROR, CY_RSLT_MODULE_BOARD_LIB_SERIAL_FLASH, 3)) |
| Parameters passed to a function are invalid. | |
| +#define | CY_RSLT_SERIAL_FLASH_ERR_READ_BUSY (cy_rslt_t)(CY_RSLT_CREATE(CY_RSLT_TYPE_ERROR, CY_RSLT_MODULE_BOARD_LIB_SERIAL_FLASH, 4)) |
| A previously initiated read operation is not yet complete. | |
| +#define | CY_RSLT_SERIAL_FLASH_ERR_DMA (cy_rslt_t)(CY_RSLT_CREATE(CY_RSLT_TYPE_ERROR, CY_RSLT_MODULE_BOARD_LIB_SERIAL_FLASH, 5)) |
| A DMA error occurred during read transfer. | |
| #define | CY_RSLT_SERIAL_FLASH_ERR_QSPI_BUSY (cy_rslt_t)(CY_RSLT_CREATE(CY_RSLT_TYPE_ERROR, CY_RSLT_MODULE_BOARD_LIB_SERIAL_FLASH, 6)) |
| Read abort failed. More... | |
Macro Definition Documentation
+ +
+
+
+
+
+
| #define CY_RSLT_SERIAL_FLASH_ERR_QSPI_BUSY (cy_rslt_t)(CY_RSLT_CREATE(CY_RSLT_TYPE_ERROR, CY_RSLT_MODULE_BOARD_LIB_SERIAL_FLASH, 6)) | +
+
+
+Read abort failed.
+QSPI block is busy.
+ +
+
+
+
+
+
+
+
+
+
+
+
+ |
+
+ Over The Air (OTA) Bootloader Abstraction Library
+ |
+
+
+-
+
- Home +
- API Reference +
-
+ + ++
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/api_reference_manual/html/group__group__ota__bootsupport__typedefs.js b/docs/api_reference_manual/html/group__group__ota__bootsupport__typedefs.js
new file mode 100644
index 0000000..3aaa50e
--- /dev/null
+++ b/docs/api_reference_manual/html/group__group__ota__bootsupport__typedefs.js
@@ -0,0 +1,9 @@
+var group__group__ota__bootsupport__typedefs =
+[
+ [ "cy_ota_mem_type_t", "group__group__ota__bootsupport__typedefs.html#gaab757db963c4503260e549eadfdbaf09", [
+ [ "CY_OTA_MEM_TYPE_INTERNAL_FLASH", "group__group__ota__bootsupport__typedefs.html#ggaab757db963c4503260e549eadfdbaf09aaaba78afcb0a2d0e2ecce4d38985f249", null ],
+ [ "CY_OTA_MEM_TYPE_EXTERNAL_FLASH", "group__group__ota__bootsupport__typedefs.html#ggaab757db963c4503260e549eadfdbaf09a62af14d0a3f7a5928e8b3d31ba74c9e4", null ],
+ [ "CY_OTA_MEM_TYPE_RRAM", "group__group__ota__bootsupport__typedefs.html#ggaab757db963c4503260e549eadfdbaf09a2665c22f1ff174dea35b677a57ba76ec", null ],
+ [ "CY_OTA_MEM_TYPE_NONE", "group__group__ota__bootsupport__typedefs.html#ggaab757db963c4503260e549eadfdbaf09ad422b17cdb988fcc9e56655cc8e52326", null ]
+ ] ]
+];
\ No newline at end of file
diff --git a/docs/api_reference_manual/html/index.html b/docs/api_reference_manual/html/index.html
new file mode 100644
index 0000000..38311ff
--- /dev/null
+++ b/docs/api_reference_manual/html/index.html
@@ -0,0 +1,435 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Bootloader Support Typedefs
+
+
+
+General Description
+Typedefs used by the OTA Bootloader Support.
++Enumerations | |
| enum | cy_ota_mem_type_t { + CY_OTA_MEM_TYPE_INTERNAL_FLASH = 0, + + CY_OTA_MEM_TYPE_EXTERNAL_FLASH, + + CY_OTA_MEM_TYPE_RRAM, + + CY_OTA_MEM_TYPE_NONE + + } |
| Enumeration of OTA storage types. More... | |
Enumeration Type Documentation
+ +
+
+
+
+
+
+| enum cy_ota_mem_type_t | +
+
+
+
+
+
+
+
+
+
+
+
+ |
+
+ Over The Air (OTA) Bootloader Abstraction Library
+ |
+
+
+-
+
- Home +
- API Reference +
-
+ + ++
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/api_reference_manual/html/infineon_logo.png b/docs/api_reference_manual/html/infineon_logo.png
new file mode 100644
index 0000000..fdb81f3
Binary files /dev/null and b/docs/api_reference_manual/html/infineon_logo.png differ
diff --git a/docs/api_reference_manual/html/jquery.js b/docs/api_reference_manual/html/jquery.js
new file mode 100644
index 0000000..daead15
--- /dev/null
+++ b/docs/api_reference_manual/html/jquery.js
@@ -0,0 +1,72 @@
+/*!
+ * jQuery JavaScript Library v1.7.1
+ * http://jquery.com/
+ *
+ * Copyright 2011, John Resig
+ * Dual licensed under the MIT or GPL Version 2 licenses.
+ * http://jquery.org/license
+ *
+ * Includes Sizzle.js
+ * http://sizzlejs.com/
+ * Copyright 2011, The Dojo Foundation
+ * Released under the MIT, BSD, and GPL Licenses.
+ *
+ * Date: Mon Nov 21 21:11:03 2011 -0500
+ */
+(function(bb,L){var av=bb.document,bu=bb.navigator,bl=bb.location;var b=(function(){var bF=function(b0,b1){return new bF.fn.init(b0,b1,bD)},bU=bb.jQuery,bH=bb.$,bD,bY=/^(?:[^#<]*(<[\w\W]+>)[^>]*$|#([\w\-]*)$)/,bM=/\S/,bI=/^\s+/,bE=/\s+$/,bA=/^<(\w+)\s*\/?>(?:<\/\1>)?$/,bN=/^[\],:{}\s]*$/,bW=/\\(?:["\\\/bfnrt]|u[0-9a-fA-F]{4})/g,bP=/"[^"\\\n\r]*"|true|false|null|-?\d+(?:\.\d*)?(?:[eE][+\-]?\d+)?/g,bJ=/(?:^|:|,)(?:\s*\[)+/g,by=/(webkit)[ \/]([\w.]+)/,bR=/(opera)(?:.*version)?[ \/]([\w.]+)/,bQ=/(msie) ([\w.]+)/,bS=/(mozilla)(?:.*? rv:([\w.]+))?/,bB=/-([a-z]|[0-9])/ig,bZ=/^-ms-/,bT=function(b0,b1){return(b1+"").toUpperCase()},bX=bu.userAgent,bV,bC,e,bL=Object.prototype.toString,bG=Object.prototype.hasOwnProperty,bz=Array.prototype.push,bK=Array.prototype.slice,bO=String.prototype.trim,bv=Array.prototype.indexOf,bx={};bF.fn=bF.prototype={constructor:bF,init:function(b0,b4,b3){var b2,b5,b1,b6;if(!b0){return this}if(b0.nodeType){this.context=this[0]=b0;this.length=1;return this}if(b0==="body"&&!b4&&av.body){this.context=av;this[0]=av.body;this.selector=b0;this.length=1;return this}if(typeof b0==="string"){if(b0.charAt(0)==="<"&&b0.charAt(b0.length-1)===">"&&b0.length>=3){b2=[null,b0,null]}else{b2=bY.exec(b0)}if(b2&&(b2[1]||!b4)){if(b2[1]){b4=b4 instanceof bF?b4[0]:b4;b6=(b4?b4.ownerDocument||b4:av);b1=bA.exec(b0);if(b1){if(bF.isPlainObject(b4)){b0=[av.createElement(b1[1])];bF.fn.attr.call(b0,b4,true)}else{b0=[b6.createElement(b1[1])]}}else{b1=bF.buildFragment([b2[1]],[b6]);b0=(b1.cacheable?bF.clone(b1.fragment):b1.fragment).childNodes}return bF.merge(this,b0)}else{b5=av.getElementById(b2[2]);if(b5&&b5.parentNode){if(b5.id!==b2[2]){return b3.find(b0)}this.length=1;this[0]=b5}this.context=av;this.selector=b0;return this}}else{if(!b4||b4.jquery){return(b4||b3).find(b0)}else{return this.constructor(b4).find(b0)}}}else{if(bF.isFunction(b0)){return b3.ready(b0)}}if(b0.selector!==L){this.selector=b0.selector;this.context=b0.context}return bF.makeArray(b0,this)},selector:"",jquery:"1.7.1",length:0,size:function(){return this.length},toArray:function(){return bK.call(this,0)},get:function(b0){return b0==null?this.toArray():(b0<0?this[this.length+b0]:this[b0])},pushStack:function(b1,b3,b0){var b2=this.constructor();if(bF.isArray(b1)){bz.apply(b2,b1)}else{bF.merge(b2,b1)}b2.prevObject=this;b2.context=this.context;if(b3==="find"){b2.selector=this.selector+(this.selector?" ":"")+b0}else{if(b3){b2.selector=this.selector+"."+b3+"("+b0+")"}}return b2},each:function(b1,b0){return bF.each(this,b1,b0)},ready:function(b0){bF.bindReady();bC.add(b0);return this},eq:function(b0){b0=+b0;return b0===-1?this.slice(b0):this.slice(b0,b0+1)},first:function(){return this.eq(0)},last:function(){return this.eq(-1)},slice:function(){return this.pushStack(bK.apply(this,arguments),"slice",bK.call(arguments).join(","))},map:function(b0){return this.pushStack(bF.map(this,function(b2,b1){return b0.call(b2,b1,b2)}))},end:function(){return this.prevObject||this.constructor(null)},push:bz,sort:[].sort,splice:[].splice};bF.fn.init.prototype=bF.fn;bF.extend=bF.fn.extend=function(){var b9,b2,b0,b1,b6,b7,b5=arguments[0]||{},b4=1,b3=arguments.length,b8=false;if(typeof b5==="boolean"){b8=b5;b5=arguments[1]||{};b4=2}if(typeof b5!=="object"&&!bF.isFunction(b5)){b5={}}if(b3===b4){b5=this;--b4}for(;b4
+
+
+
+
+
+
+
+Over The Air(OTA) Bootloader Abstraction Library Overview
+
+This library offers assistance for handling downloaded over-the-air (OTA) updates of the application code that is executed on a PSoC™ 6 Connectivity Device, a 20829(CYW920829M2EVK-02) Device, or an XMC7200(KIT_XMC72_EVK) Device based on selected bootloader.
+
+ The library implements storage interface APIs required by ota-update library to complete OTA on supported platforms. Current version(v1.X) of ota-bootloader-abstraction has storage interface APIs for MCUBootloader based OTA.
+
+ The ModusToolbox MCUBootloader based OTA code examples import this library automatically along with ota-update library.
+Features and Functionality
+This library has implementation of storage interface APIs required by ota-update library to complete OTA on supported platforms.
+Other features:
+-
+
- Template flashmaps for supported platforms. +
- Template OTA linker files for supported platforms and toolchains. +
- Prebuild and Postbuild scripts for generating BOOT and UPGRADE images of OTA Application. +
- OTA image signing scripts. +
+Integration Notes
+To add different bootloader support on Infineon connectivity-enabled MCU platforms, ota-update library offloads bootloader dependent storage interface APIs using callback mechanism. To handle downloaded OTA upgrade images ota-update library calls registered storage interface callbacks. This ota-bootloader-abstraction library provides implementation of these storage interface APIs for different bootloaders along with build environment required to generate BOOT and UPGRADE images of OTA applications.
+ Current version of library supports only MCUBootloader based OTA image handling.
The user is expected to:
+
-
+
- Build and program MCUBootApp on the chosen platform(s) before enabling MCUBootloader based OTA in an application. Refer to refer to MCUBootApp README <mtb_shared>/ota-bootloader-abstraction/<version>/source/COMPONENT_MCUBOOT/MCUBOOT_APP_README.md.
+
+ - Update OTA Application Makefile by referring OTA Bootloader Abstraction Makefile Readme <mtb_shared>/ota-bootloader-abstraction/<version>/source/COMPONENT_MCUBOOT/MCUBOOT_OTA_MAKEFILE_INFO_README.md.
+
+ - ota-bootloader-abstraction library has makefile mcuboot_support.mk located in <mtb_shared>/ota-bootloader-abstraction/<version>/makefiles/mcuboot/ which has necessary pre and post build scripts for generating MCUBootloader based BOOT and UPGRADE images of OTA application.
+
+ - Include mcuboot_support.mk which is located in <mtb_shared>/ota-bootloader-abstraction/<version>/makefiles/mcuboot/ from OTA Application Makefile.
+
+ - Configure OTA storage interface callback APIs in OTA application, And pass the same storage interface while starting OTA agent.
+
+ - OTA storage interface calls Flash operations(Read, Write, erase) to store upgrade images in UPGRADE slot. ota-bootloader-abstraction implements flash operation using mtb-pdl-cat1 library APIs and implementation is available in configs folder <mtb_shared>/ota-bootloader-abstraction/<version>/configs/COMPONENT_MCUBOOT/flash/. User can use same implementation by copying contents of <mtb_shared>/ota-bootloader-abstraction/<version>/configs/COMPONENT_MCUBOOT/flash/) to application space or Can implement flash operation APIs defined in <mtb_shared>/ota-bootloader-abstraction/<version>/source/COMPONENT_MCUBOOT/cy_ota_flash.h.
+
+ - For MCUBootloader based OTA Support, add the following to the project Makefile:
+CY_BOOTLOADER=MCUBOOT+
+
+ - Add Application Build Directory in the project Makefile:
+CY_BUILD_LOCATION=<Application's Build Working Directory path>+
+
+ - Add OTA platform in the project Makefile:
+Refer OTA Bootloader Abstraction Makefile Readme <mtb_shared>/ota-bootloader-abstraction/<version>/source/COMPONENT_MCUBOOT/MCUBOOT_OTA_MAKEFILE_INFO_README.md.OTA_PLATFORM=<platform_type>+
+
+
+ - Add linker file path for MCUBootloader based OTA on choosen platform in the project Makefile:
+OTA_LINKER_FILE=<OTA linker file path>+
+ There are other components that may be needed based on support. Please refer to the various readme files in the folder <mtb_shared>/ota-bootloader-abstraction/<version>/source/COMPONENT_MCUBOOT/.
+ MCUBOOT_APP_README.md
+ MCUBOOT_BUILD_COMMANDS.md
+ MCUBOOT_OTA_FLASH_LAYOUT_README.md
+ MCUBOOT_OTA_MAKEFILE_INFO_README.md
+ README.md in library root directory.
+
+
+General Concept
+The OTA Bootloader Abstraction provides bootloader specific storage interface API implementation which can be used with ota-update library for handling downloaded OTA application upgrade images. During reboot bootloader validates and boots upgrade image.
+
+ The basic device boot sequence is as follows:
+
-
+
- ROM boot will start Bootloader.
+
+ - Bootloader runs the current application(BOOT Image) in the Primary slot.
+
+ - The OTA Agent downloads the update(UPGRADE Image) and stores it in the Secondary slot using storage interface APIs.
+
+ - The OTA Agent marks the upgrade as ready using storage interface API.
+
+ On the next system boot:
+
+
-
+
- ROM boot will start Bootloader.
+
+ - If no update is downloaded, Bootloader starts the current application.
+
+ - Bootloader determines if there is an update in the Secondary Slot.
+
+ - If there is an update available:
+ a. Bootloader verifies the update.
+ b. Bootloader boots upgrade image either by copying or switching Primary and Secondary Slots.
+ c. The updated application must call cy_ota_storage_validated() to validate the update.
+
+ MCUBootloader Support:
+ This library has below support for MCUBootloader based OTA on PSoC6, 20829,and XMC7200 platforms.
+
+
-
+
- Template flashmaps for PSoC6, 20829, and XMC7200 platforms.
+
+ - Template linker files for GCC_ARM, ARM, and IAR toolchains.
+
+ - Storage operation callback APIs to handle MCUBootloader based upgrade image.
+
+ - Prebuild and Postbuild scripts for generating and signing MCUBootloader based BOOT and UPGRADE image of an OTA Application.
+
+
+API Overview
+1. Initialize Storage Area
+cy_ota_storage_init() - Initializes flash, QSPI flash, or any other external memory type.
+ Application is expected to call this API once before starting OTA agent.
+ cy_rslt_t cy_ota_storage_init(void);
2. Open Storage Area
+cy_ota_storage_open() - Open storage Area for storing OTA UPGRADE images.
+ Typically, this erases UPGRADE slots as well. The OTA agent will call this API once OTA image download starts.
+ cy_rslt_t cy_ota_storage_open(cy_ota_storage_context_t *storage_ptr);
3. Read data from Storage Area.
+cy_ota_storage_read() - Read data from Storage Area.
+ The Read API is primarily used by OTA agents to read OTA Image headers.
+ cy_rslt_t cy_ota_storage_read(cy_ota_storage_context_t *storage_ptr, cy_ota_storage_read_info_t *chunk_info);
4. Write data to Storage Area.
+cy_ota_storage_write() - Write data to Storage Area.
+ The Write API is mainly utilized by OTA agents to write OTA upgrade images that have been downloaded.
+ cy_rslt_t cy_ota_storage_write(cy_ota_storage_context_t *storage_ptr, cy_ota_storage_write_info_t *chunk_info);
5. Close Storage Area.
+cy_ota_storage_close() - Close Storage Area.
+ This API is responsible for closing the storage context. After the context is closed, it will not be possible to perform any write or read operations.
+ cy_rslt_t cy_ota_storage_close(cy_ota_storage_context_t *storage_ptr);
6. Verify downloaded UPGRADE OTA image.
+cy_ota_storage_verify() - Verify OTA image.
+ The OTA agent provides an application callback for image verification before invoking this API.
+ cy_rslt_t cy_ota_storage_verify(cy_ota_storage_context_t *storage_ptr);
7. Validate currently running APP.
+cy_ota_storage_validated() - Validates currently executing application and makes it boot image until next upgrade is available.
+ The application is expected to call this API to execute an image as the boot image until the next upgrade image becomes available.
+ cy_rslt_t cy_ota_storage_validated(void);
8. Get Application Image information
+cy_ota_storage_get_app_info() - Get Application version, Application ID information.
+ The header of an application image (BOOT/UPGRADE) typically includes the following information.
+ cy_rslt_t cy_ota_storage_get_app_info(void* file_des, cy_ota_app_info_t *app_info);
+Code Snippets
+1. Override Default Flash operations API implementation:
+ Copy flash operation implementations from folder ota-bootloader-abstraction/<version>/configs/COMPONENT_MCUBOOT/flash directory to the top-level code example directory in the project. Change these implementation if required.
+
+
/*
+ * Copy flash operation flash implementations from '<ota-bootloader-abstraction>/configs/COMPONENT_MCUBOOT/flash/' to application space.
+ * Change default implementation if required.
+ */
+
+cy_rslt_t cy_ota_mem_init(void)
+{
+ /*
+ * Implement code logic to Initialize flash, QSPI flash, or any other external memory type
+ */
+ return CY_RSLT_SUCCESS;
+}
+
+
+{
+ UNUSED_ARG(mem_type);
+ UNUSED_ARG(addr);
+ UNUSED_ARG(data);
+ UNUSED_ARG(len);
+
+ /*
+ * Implement code logic to read from flash, QSPI flash, or any other external memory type
+ */
+
+ return CY_RSLT_SUCCESS;
+}
+
+
+{
+ UNUSED_ARG(mem_type);
+ UNUSED_ARG(addr);
+ UNUSED_ARG(data);
+ UNUSED_ARG(len);
+
+ /*
+ * Implement code logic to write data to flash, QSPI flash, or any other external memory type
+ */
+
+ return CY_RSLT_SUCCESS;
+}
+
+
+{
+ UNUSED_ARG(mem_type);
+ UNUSED_ARG(addr);
+ UNUSED_ARG(len);
+
+ /*
+ * Implement code logic to erase flash, QSPI flash, or any other external memory type
+ */
+
+ return CY_RSLT_SUCCESS;
+}
+
+
+{
+ UNUSED_ARG(mem_type);
+ UNUSED_ARG(addr);
+
+ /*
+ * Implement code logic to get programming page size of flash, QSPI flash, or any other external memory type
+ */
+
+ return CY_RSLT_SUCCESS;
+}
+
+
+{
+ UNUSED_ARG(mem_type);
+ UNUSED_ARG(addr);
+
+ /*
+ * Implement code logic to get sector erase size flash, QSPI flash, or any other external memory type
+ */
+
+ return CY_RSLT_SUCCESS;
+}
+
+
+ 2. Registering Storage Interface APIs:
+ The following code snippet demonstrates an example for initializing the cy_ota_storage_interface_t structure which is required to start the OTA Agent.
+ This example functions also demonstrates the usage of the OTA Storage Interface APIs for Upgrade image handling (read/write/validate) callback functions.
+
/* Macro to enable/disable TLS. */
+#define ENABLE_TLS (false)
+
+#define HTTP_SERVER "my.httpserver.com"
+#define HTTP_SERVER_PORT (80) /* 443 for TLS. */
+
+/* Number of MQTT topic filters. */
+#define MQTT_TOPIC_FILTER_NUM (1)
+
+#define MQTT_BROKER "mqtt.broker.com"
+
+#define MQTT_BROKER_PORT (1883) /* (8883) for TLS support. */
+/* MQTT topics. */
+const char * mqtt_topics[ MQTT_TOPIC_FILTER_NUM ] =
+{
+ "mtb/test/ota/image"
+};
+
+/* Root CA Certificate.
+ Must include the PEM header and footer:
+
+
"-----BEGIN CERTIFICATE-----\n" \
+ ".........base64 data.......\n" \
+ "-----END CERTIFICATE-------\n"
+*/
+#define ROOT_CA_CERTIFICATE ""
+
+/* Client Certificate.
+ Must include the PEM header and footer:
+
+
"-----BEGIN CERTIFICATE-----\n" \
+ ".........base64 data.......\n" \
+ "-----END CERTIFICATE-------\n"
+*/
+#define CLIENT_CERTIFICATE ""
+
+
+/* Private Key.
+ Must include the PEM header and footer:
+
+
"-----BEGIN RSA PRIVATE KEY-----\n" \
+ "...........base64 data.........\n" \
+ "-----END RSA PRIVATE KEY-------\n"
+*/
+#define CLIENT_KEY ""
+
+/* OTA context. */
+static cy_ota_context_ptr ota_context;
+
+/* OTA callback function define. */
+cy_ota_callback_results_t ota_callback(cy_ota_cb_struct_t *cb_data);
+
+
+/* network parameters for OTA. */
+cy_ota_network_params_t network_params = { CY_OTA_CONNECTION_UNKNOWN };
+
+/* Parameters for the OTA Agent. */
+cy_ota_agent_params_t ota_agent_params =
+{
+ .cb_func = ota_callback, /* Set the value to NULL if the callback function is not used. */
+ .cb_arg = &ota_context, /* Set the value to NULL if the callback function is not used. */
+ .reboot_upon_completion = 1 /* Reboot after completing OTA with success. */
+};
+
+cy_ota_storage_interface_t ota_interfaces =
+{
+ .ota_file_open = cy_ota_storage_open,
+ .ota_file_read = cy_ota_storage_read,
+ .ota_file_write = cy_ota_storage_write,
+ .ota_file_close = cy_ota_storage_close,
+ .ota_file_verify = cy_ota_storage_verify,
+ .ota_file_validate = cy_ota_storage_validated,
+ .ota_file_get_app_info = cy_ota_storage_get_app_info
+};
+
+int main(void)
+{
+ /* BSP Init */
+
+ /* Memory Init */
+
+ /* Start OTA Agent.*/
+ result = cy_ota_agent_start(&ota_test_network_params, &ota_test_agent_params, &ota_interfaces, &ota_context);
+ if (result != CY_RSLT_SUCCESS)
+ {
+ printf("Agent start Failed - result: 0x%lx\n", result);
+ while (true)
+ {
+ cy_rtos_delay_milliseconds(10);
+ }
+ }
+}
+
+
+ModusToolbox OTA Code Examples
+ModusToolbox OTA Example using MQTT: https://github.com/infineon/mtb-example-ota-mqtt
+ ModusToolbox OTA Update Bluetooth® example: https://github.com/infineon/mtb-example-btstack-freertos-cyw20829-keyboard
+ MCUboot documentation: https://github.com/JuulLabs-OSS/mcuboot/blob/cypress/docs/design.md
+
| t |
","
"]}b.fn.extend({text:function(e){if(b.isFunction(e)){return this.each(function(bw){var bv=b(this);bv.text(e.call(this,bw,bv.text()))})}if(typeof e!=="object"&&e!==L){return this.empty().append((this[0]&&this[0].ownerDocument||av).createTextNode(e))}return b.text(this)},wrapAll:function(e){if(b.isFunction(e)){return this.each(function(bw){b(this).wrapAll(e.call(this,bw))})}if(this[0]){var bv=b(e,this[0].ownerDocument).eq(0).clone(true);if(this[0].parentNode){bv.insertBefore(this[0])}bv.map(function(){var bw=this;while(bw.firstChild&&bw.firstChild.nodeType===1){bw=bw.firstChild}return bw}).append(this)}return this},wrapInner:function(e){if(b.isFunction(e)){return this.each(function(bv){b(this).wrapInner(e.call(this,bv))})}return this.each(function(){var bv=b(this),bw=bv.contents();if(bw.length){bw.wrapAll(e)}else{bv.append(e)}})},wrap:function(e){var bv=b.isFunction(e);return this.each(function(bw){b(this).wrapAll(bv?e.call(this,bw):e)})},unwrap:function(){return this.parent().each(function(){if(!b.nodeName(this,"body")){b(this).replaceWith(this.childNodes)}}).end()},append:function(){return this.domManip(arguments,true,function(e){if(this.nodeType===1){this.appendChild(e)}})},prepend:function(){return this.domManip(arguments,true,function(e){if(this.nodeType===1){this.insertBefore(e,this.firstChild)}})},before:function(){if(this[0]&&this[0].parentNode){return this.domManip(arguments,false,function(bv){this.parentNode.insertBefore(bv,this)})}else{if(arguments.length){var e=b.clean(arguments);e.push.apply(e,this.toArray());return this.pushStack(e,"before",arguments)}}},after:function(){if(this[0]&&this[0].parentNode){return this.domManip(arguments,false,function(bv){this.parentNode.insertBefore(bv,this.nextSibling)})}else{if(arguments.length){var e=this.pushStack(this,"after",arguments);e.push.apply(e,b.clean(arguments));return e}}},remove:function(e,bx){for(var bv=0,bw;(bw=this[bv])!=null;bv++){if(!e||b.filter(e,[bw]).length){if(!bx&&bw.nodeType===1){b.cleanData(bw.getElementsByTagName("*"));b.cleanData([bw])}if(bw.parentNode){bw.parentNode.removeChild(bw)}}}return this},empty:function(){for(var e=0,bv;(bv=this[e])!=null;e++){if(bv.nodeType===1){b.cleanData(bv.getElementsByTagName("*"))}while(bv.firstChild){bv.removeChild(bv.firstChild)}}return this},clone:function(bv,e){bv=bv==null?false:bv;e=e==null?bv:e;return this.map(function(){return b.clone(this,bv,e)})},html:function(bx){if(bx===L){return this[0]&&this[0].nodeType===1?this[0].innerHTML.replace(ag,""):null}else{if(typeof bx==="string"&&!ae.test(bx)&&(b.support.leadingWhitespace||!ar.test(bx))&&!ax[(d.exec(bx)||["",""])[1].toLowerCase()]){bx=bx.replace(R,"<$1>");try{for(var bw=0,bv=this.length;bw
');
+}
+
+function showSyncOn(n,relpath)
+{
+ n.html('
');
+}
+
+function toggleSyncButton(relpath)
+{
+ var navSync = $('#nav-sync');
+ if (navSync.hasClass('sync')) {
+ navSync.removeClass('sync');
+ showSyncOff(navSync,relpath);
+ storeLink(stripPath2(pathName())+hashUrl());
+ } else {
+ navSync.addClass('sync');
+ showSyncOn(navSync,relpath);
+ deleteLink();
+ }
+}
+
+function initNavTree(toroot,relpath)
+{
+ var o = new Object();
+ o.toroot = toroot;
+ o.node = new Object();
+ o.node.li = document.getElementById("nav-tree-contents");
+ o.node.childrenData = NAVTREE;
+ o.node.children = new Array();
+ o.node.childrenUL = document.createElement("ul");
+ o.node.getChildrenUL = function() { return o.node.childrenUL; };
+ o.node.li.appendChild(o.node.childrenUL);
+ o.node.depth = 0;
+ o.node.relpath = relpath;
+ o.node.expanded = false;
+ o.node.isLast = true;
+ o.node.plus_img = document.createElement("img");
+ o.node.plus_img.src = relpath+"ftv2pnode.png";
+ o.node.plus_img.width = 16;
+ o.node.plus_img.height = 22;
+
+ if (localStorageSupported()) {
+ var navSync = $('#nav-sync');
+ if (cachedLink()) {
+ showSyncOff(navSync,relpath);
+ navSync.removeClass('sync');
+ } else {
+ showSyncOn(navSync,relpath);
+ }
+ navSync.click(function(){ toggleSyncButton(relpath); });
+ }
+
+ $(window).load(function(){
+ navTo(o,toroot,hashUrl(),relpath);
+ showRoot();
+ });
+
+ $(window).bind('hashchange', function(){
+ if (window.location.hash && window.location.hash.length>1){
+ var a;
+ if ($(location).attr('hash')){
+ var clslink=stripPath(pathName())+':'+hashValue();
+ a=$('.item a[class$="'+clslink.replace(/=0) window.location.hash=url.substr(i);
+ var _preventDefault = function(evt) { evt.preventDefault(); };
+ $("#splitbar").bind("dragstart", _preventDefault).bind("selectstart", _preventDefault);
+ $(document).bind('touchmove',function(e){
+ var device = navigator.userAgent.toLowerCase();
+ var ios = device.match(/(iphone|ipod|ipad)/);
+ if (ios) {
+ try {
+ var target = e.target;
+ while (target) {
+ if ($(target).css('-webkit-overflow-scrolling')=='touch') return;
+ target = target.parentNode;
+ }
+ e.preventDefault();
+ } catch(err) {
+ e.preventDefault();
+ }
+ }
+ });
+}
diff --git a/docs/api_reference_manual/html/search/all_0.html b/docs/api_reference_manual/html/search/all_0.html
new file mode 100644
index 0000000..86e6c08
--- /dev/null
+++ b/docs/api_reference_manual/html/search/all_0.html
@@ -0,0 +1,26 @@
+
+