195 lines
11 KiB
HTML
195 lines
11 KiB
HTML
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|||
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|||
|
|
<head>
|
|||
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|||
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|||
|
|
<meta name="generator" content="Doxygen 1.9.6"/>
|
|||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|||
|
|
<!-- BEGIN opengraph metadata -->
|
|||
|
|
<meta property="og:title" content="Doxygen Awesome" />
|
|||
|
|
<meta property="og:image" content="https://repository-images.githubusercontent.com/348492097/4f16df80-88fb-11eb-9d31-4015ff22c452" />
|
|||
|
|
<meta property="og:description" content="Custom CSS theme for doxygen html-documentation with lots of customization parameters." />
|
|||
|
|
<meta property="og:url" content="https://jothepro.github.io/doxygen-awesome-css/" />
|
|||
|
|
<!-- END opengraph metadata -->
|
|||
|
|
<!-- BEGIN twitter metadata -->
|
|||
|
|
<meta name="twitter:image:src" content="https://repository-images.githubusercontent.com/348492097/4f16df80-88fb-11eb-9d31-4015ff22c452" />
|
|||
|
|
<meta name="twitter:title" content="Doxygen Awesome" />
|
|||
|
|
<meta name="twitter:description" content="Custom CSS theme for doxygen html-documentation with lots of customization parameters." />
|
|||
|
|
<!-- END twitter metadata -->
|
|||
|
|
<title>User Guide: Application</title>
|
|||
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|||
|
|
<link rel="icon" type="image/svg+xml" href="logo.drawio.svg"/>
|
|||
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|||
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|||
|
|
<script type="text/javascript" src="doxygen-awesome-darkmode-toggle.js"></script>
|
|||
|
|
<script type="text/javascript" src="doxygen-awesome-fragment-copy-button.js"></script>
|
|||
|
|
<script type="text/javascript" src="doxygen-awesome-paragraph-link.js"></script>
|
|||
|
|
<script type="text/javascript" src="doxygen-awesome-interactive-toc.js"></script>
|
|||
|
|
<script type="text/javascript" src="doxygen-awesome-tabs.js"></script>
|
|||
|
|
<script type="text/javascript" src="toggle-alternative-theme.js"></script>
|
|||
|
|
<script type="text/javascript">
|
|||
|
|
DoxygenAwesomeFragmentCopyButton.init()
|
|||
|
|
DoxygenAwesomeDarkModeToggle.init()
|
|||
|
|
DoxygenAwesomeParagraphLink.init()
|
|||
|
|
DoxygenAwesomeInteractiveToc.init()
|
|||
|
|
DoxygenAwesomeTabs.init()
|
|||
|
|
</script>
|
|||
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|||
|
|
<script type="text/javascript" src="resize.js"></script>
|
|||
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|||
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|||
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|||
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|||
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|||
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|||
|
|
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
|
|||
|
|
<link href="custom.css" rel="stylesheet" type="text/css"/>
|
|||
|
|
<link href="doxygen-awesome-sidebar-only.css" rel="stylesheet" type="text/css"/>
|
|||
|
|
<link href="doxygen-awesome-sidebar-only-darkmode-toggle.css" rel="stylesheet" type="text/css"/>
|
|||
|
|
<link href="custom-alternative.css" rel="stylesheet" type="text/css"/>
|
|||
|
|
</head>
|
|||
|
|
<body>
|
|||
|
|
<!-- https://tholman.com/github-corners/
|
|||
|
|
<a href="https://github.com/jothepro/doxygen-awesome-css" class="github-corner" title="View source on GitHub" target="_blank">
|
|||
|
|
<svg viewBox="0 0 250 250" width="40" height="40" style="position: absolute; top: 0; border: 0; right: 0; z-index: 99;" aria-hidden="true">
|
|||
|
|
<path d="M0,0 L115,115 L130,115 L142,142 L250,250 L250,0 Z"></path><path d="M128.3,109.0 C113.8,99.7 119.0,89.6 119.0,89.6 C122.0,82.7 120.5,78.6 120.5,78.6 C119.2,72.0 123.4,76.3 123.4,76.3 C127.3,80.9 125.5,87.3 125.5,87.3 C122.9,97.6 130.6,101.9 134.4,103.2" fill="currentColor" style="transform-origin: 130px 106px;" class="octo-arm"></path><path d="M115.0,115.0 C114.9,115.1 118.7,116.5 119.8,115.4 L133.7,101.6 C136.9,99.2 139.9,98.4 142.2,98.6 C133.8,88.0 127.5,74.4 143.8,58.0 C148.5,53.4 154.0,51.2 159.7,51.0 C160.3,49.4 163.2,43.6 171.4,40.1 C171.4,40.1 176.1,42.5 178.8,56.2 C183.1,58.6 187.2,61.8 190.9,65.4 C194.5,69.0 197.7,73.2 200.1,77.6 C213.8,80.2 216.3,84.9 216.3,84.9 C212.7,93.1 206.9,96.0 205.4,96.6 C205.1,102.4 203.0,107.8 198.3,112.5 C181.9,128.9 168.3,122.5 157.7,114.1 C157.9,116.9 156.7,120.9 152.7,124.9 L141.0,136.5 C139.8,137.7 141.6,141.9 141.8,141.8 Z" fill="currentColor" class="octo-body"></path></svg></a><style>.github-corner:hover .octo-arm{animation:octocat-wave 560ms ease-in-out}@keyframes octocat-wave{0%,100%{transform:rotate(0)}20%,60%{transform:rotate(-25deg)}40%,80%{transform:rotate(10deg)}}@media (max-width:500px){.github-corner:hover .octo-arm{animation:none}.github-corner .octo-arm{animation:octocat-wave 560ms ease-in-out}}</style>
|
|||
|
|
-->
|
|||
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|||
|
|
<div id="titlearea">
|
|||
|
|
<table cellspacing="0" cellpadding="0">
|
|||
|
|
<tbody>
|
|||
|
|
<tr style="height: 56px;">
|
|||
|
|
<td id="projectlogo"><img alt="Logo" src="Logo.png"/></td>
|
|||
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|||
|
|
<div id="projectname">User Guide
|
|||
|
|
</div>
|
|||
|
|
<div id="projectbrief">Bluetooth Low Energy 5.3</div>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</div>
|
|||
|
|
<!-- end header part -->
|
|||
|
|
<!-- Generated by Doxygen 1.9.6 -->
|
|||
|
|
<script type="text/javascript">
|
|||
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|||
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|||
|
|
/* @license-end */
|
|||
|
|
</script>
|
|||
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|||
|
|
<script type="text/javascript" src="menu.js"></script>
|
|||
|
|
<script type="text/javascript">
|
|||
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|||
|
|
$(function() {
|
|||
|
|
initMenu('',true,false,'search.php','Search');
|
|||
|
|
$(document).ready(function() { init_search(); });
|
|||
|
|
});
|
|||
|
|
/* @license-end */
|
|||
|
|
</script>
|
|||
|
|
<div id="main-nav"></div>
|
|||
|
|
</div><!-- top -->
|
|||
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|||
|
|
<div id="nav-tree">
|
|||
|
|
<div id="nav-tree-contents">
|
|||
|
|
<div id="nav-sync" class="sync"></div>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|||
|
|
class="ui-resizable-handle">
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<script type="text/javascript">
|
|||
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|||
|
|
$(document).ready(function(){initNavTree('APPLICATION.html',''); initResizable(); });
|
|||
|
|
/* @license-end */
|
|||
|
|
</script>
|
|||
|
|
<div id="doc-content">
|
|||
|
|
<!-- window showing the filter options -->
|
|||
|
|
<div id="MSearchSelectWindow"
|
|||
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|||
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|||
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
<!-- iframe showing the search results (closed by default) -->
|
|||
|
|
<div id="MSearchResultsWindow">
|
|||
|
|
<div id="MSearchResults">
|
|||
|
|
<div class="SRPage">
|
|||
|
|
<div id="SRIndex">
|
|||
|
|
<div id="SRResults"></div>
|
|||
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
|||
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
|||
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
<div><div class="header">
|
|||
|
|
<div class="headertitle"><div class="title">Application </div></div>
|
|||
|
|
</div><!--header-->
|
|||
|
|
<div class="contents">
|
|||
|
|
<div class="textblock"><p><a class="anchor" id="md_docs_doxygen_om6626_user_guides_application"></a></p>
|
|||
|
|
<h1><a class="anchor" id="autotoc_md27"></a>
|
|||
|
|
SDK Directory</h1>
|
|||
|
|
<p>SDK directory is as show below:</p>
|
|||
|
|
<div class="fragment"><div class="line">▾ bsp/ BSP</div>
|
|||
|
|
<div class="line">▸ common/ Common file, such as list/fifo/log ...</div>
|
|||
|
|
<div class="line">▾ components/ Components files</div>
|
|||
|
|
<div class="line"> ▸ ble/ BLE stack API</div>
|
|||
|
|
<div class="line"> ▸ crypto/ Some crypto algorithm</div>
|
|||
|
|
<div class="line"> ▸ evt/ Event schedule source code</div>
|
|||
|
|
<div class="line"> ▸ mbr/ MBR</div>
|
|||
|
|
<div class="line"> ▸ nvds/ Non Volatile Data Storage (NVDS) system</div>
|
|||
|
|
<div class="line"> ▸ pm/ Power manager</div>
|
|||
|
|
<div class="line"> ▸ shell/ Shell</div>
|
|||
|
|
<div class="line"> ▸ trace/ Trace</div>
|
|||
|
|
<div class="line"> ▸ unity/ Unity test code</div>
|
|||
|
|
<div class="line">▸ docs/ Document</div>
|
|||
|
|
<div class="line">▾ hal/ Hardware driver</div>
|
|||
|
|
<div class="line"> ▸ CMSIS/ ARM CMSIS driver and its source code</div>
|
|||
|
|
<div class="line"> ▸ device/ Peripheral driver and its source code</div>
|
|||
|
|
<div class="line"> ▸ driver/ Peripheral driver and its source code</div>
|
|||
|
|
<div class="line">▸ include/ Some include files</div>
|
|||
|
|
<div class="line">▾ projects/ Projects</div>
|
|||
|
|
<div class="line"> ▸ ble_app_hci/ BLE HCI project</div>
|
|||
|
|
<div class="line"> ▸ ble_app_simple/ BLE simple server demo project</div>
|
|||
|
|
<div class="line"> ▸ om24g_app_simple/ 2.4GHz Proprietary demo project</div>
|
|||
|
|
<div class="line"> ▸ ...</div>
|
|||
|
|
<div class="line">▸ tools/ Tools</div>
|
|||
|
|
<div class="line"> ▸ build/ Build tools</div>
|
|||
|
|
<div class="line"> ▾ plugins/ IDE support plugins</div>
|
|||
|
|
<div class="line"> ▸ iar/ IAR support</div>
|
|||
|
|
<div class="line"> ▸ jlink/ Segger JLink support</div>
|
|||
|
|
<div class="line"> ▸ keil/ KEIL MDK support</div>
|
|||
|
|
</div><!-- fragment --><h1><a class="anchor" id="autotoc_md28"></a>
|
|||
|
|
Sample Projects</h1>
|
|||
|
|
<p>To help create user application, many sample projects in SDK have been created to start with, such as ble_app_simple and some ble related demo sample projects. Through studying sample projects, customers can easily get familar with SDK. All sample projects have been configured and memory layout in scatter file is also modified to comply with OM6XXX SOC.</p>
|
|||
|
|
<p>Taking ble_app_simple application as an example below, it shows how to start developing the customized user application by the sample project. The snapshots are captured with current SDK, and may subject to change due to SDK upgrade.</p>
|
|||
|
|
<div class="image">
|
|||
|
|
<img src="Ble_app_simple_prj.png" alt=""/>
|
|||
|
|
<div class="caption">
|
|||
|
|
ble_app_simple Sample Project</div></div>
|
|||
|
|
<p>The sample project may upgrade together with the SDK, and to better utilize the upgraded sample code, newly added user code is suggested to being organized and modularized. More detail information on each sample project could be found in its user manual.</p>
|
|||
|
|
<h1><a class="anchor" id="autotoc_md29"></a>
|
|||
|
|
Application Process Flow</h1>
|
|||
|
|
<p>There are 2 ways to run application：</p><ul>
|
|||
|
|
<li>Running in FLASH</li>
|
|||
|
|
<li>Running in SRAM (Only in TEST scenarios)</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Please reference <a class="el" href="BOOTLOADER.html">bootloader</a> for some boot infomation.</p>
|
|||
|
|
<p>The main flow is concentrated in these file:</p><ul>
|
|||
|
|
<li>startup.S (startup file)</li>
|
|||
|
|
<li>main.c (main file)</li>
|
|||
|
|
<li>linker_flash.sct (linker file) </li>
|
|||
|
|
</ul>
|
|||
|
|
</div></div><!-- contents -->
|
|||
|
|
</div><!-- PageDoc -->
|
|||
|
|
</div><!-- doc-content -->
|
|||
|
|
<!-- HTML footer for doxygen 1.9.1-->
|
|||
|
|
<!-- start footer part -->
|
|||
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|||
|
|
</div>
|
|||
|
|
</body>
|
|||
|
|
</html>
|