Skip to content

Commit

Permalink
Update documentation for release v2.0.0-dev0
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions committed Jun 11, 2024
1 parent 8e9a375 commit 9d9f147
Show file tree
Hide file tree
Showing 100 changed files with 10,329 additions and 2 deletions.
2 changes: 1 addition & 1 deletion latest
Binary file added v2.0.0-dev0/NXPSDK_overview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added v2.0.0-dev0/armkeil_white_h.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added v2.0.0-dev0/bc_s.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added v2.0.0-dev0/bc_sd.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added v2.0.0-dev0/bdwn.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added v2.0.0-dev0/closed.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
151 changes: 151 additions & 0 deletions v2.0.0-dev0/config_drivers.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,151 @@
<!-- HTML header for doxygen 1.9.6-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>i.MXRT105x Middleware Pack: Configure CMSIS-Drivers</title>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="tabs.js"></script>
<script type="text/javascript" src="footer.js"></script>
<script type="text/javascript" src="navtree.js"></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>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_search(); });
/* @license-end */
</script>
<script type="text/javascript" src="darkmode_toggle.js"></script>
<link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
<link href="extra_navtree.css" rel="stylesheet" type="text/css"/>
<link href="extra_search.css" rel="stylesheet" type="text/css"/>
<link href="extra_tabs.css" rel="stylesheet" type="text/css"/>
<link href="version.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../version.js"></script>
</head>
<body>
<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: 55px;">
<td id="projectlogo" style="padding: 1.5em;"><a href="https://www.keil.arm.com/cmsis" target="_blank"><img alt="Logo" src="armkeil_white_h.png"/</a></td>
<td style="padding-left: 1em; padding-bottom: 1em;padding-top: 1em;">
<div id="projectname">i.MXRT105x Middleware Pack
&#160;<span id="projectnumber"><script type="text/javascript">
<!--
writeHeader.call(this);
writeVersionDropdown.call(this, "i.MXRT105x Middleware Pack");
//-->
</script>
</span>
</div>
<div id="projectbrief">MDK-Middleware examples and CMSIS-Drivers for NXP i.MXRT105x devices</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
</span>
</div>
</td>
<!--END !PROJECT_NAME-->
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<div id="CMSISnav" class="tabs1">
<ul class="tablist">
<script type="text/javascript">
writeComponentTabs.call(this);
</script>
</ul>
</div>
<!-- Generated by Doxygen 1.9.6 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
</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&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('config_drivers.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">Configure CMSIS-Drivers </div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>For each CMSIS-Driver, the required configuration is explained in depth below:</p><ul>
<li><a class="el" href="evkb_imxrt1050_can.html">CMSIS-Driver for CAN Interface</a></li>
<li><a class="el" href="evkb_imxrt1050_enet.html">CMSIS-Driver for EMAC Interface</a></li>
<li><a class="el" href="evkb_imxrt1050_usdhc.html">CMSIS-Driver for MCI Interface</a></li>
<li><a class="el" href="evkb_imxrt1050_usbd.html">CMSIS-Driver for USB Device Interface</a></li>
<li><a class="el" href="evkb_imxrt1050_usbh.html">CMSIS-Driver for USB Host Interface</a></li>
</ul>
<p>Continue by <a class="el" href="implement_code.html">adding user code</a>. </p>
</div></div><!-- contents -->
</div><!-- PageDoc -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">
<script type="text/javascript">
<!--
writeFooter.call(this);
//-->
</script>
</li>
</ul>
</div>
</body>
</html>
8 changes: 8 additions & 0 deletions v2.0.0-dev0/config_drivers.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
var config_drivers =
[
[ "CMSIS-Driver for CAN Interface", "evkb_imxrt1050_can.html", null ],
[ "CMSIS-Driver for EMAC Interface", "evkb_imxrt1050_enet.html", null ],
[ "CMSIS-Driver for MCI Interface", "evkb_imxrt1050_usdhc.html", null ],
[ "CMSIS-Driver for USB Device Interface", "evkb_imxrt1050_usbd.html", null ],
[ "CMSIS-Driver for USB Host Interface", "evkb_imxrt1050_usbh.html", null ]
];
172 changes: 172 additions & 0 deletions v2.0.0-dev0/config_pg.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,172 @@
<!-- HTML header for doxygen 1.9.6-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>i.MXRT105x Middleware Pack: Usage instructions</title>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="tabs.js"></script>
<script type="text/javascript" src="footer.js"></script>
<script type="text/javascript" src="navtree.js"></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>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_search(); });
/* @license-end */
</script>
<script type="text/javascript" src="darkmode_toggle.js"></script>
<link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
<link href="extra_navtree.css" rel="stylesheet" type="text/css"/>
<link href="extra_search.css" rel="stylesheet" type="text/css"/>
<link href="extra_tabs.css" rel="stylesheet" type="text/css"/>
<link href="version.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../version.js"></script>
</head>
<body>
<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: 55px;">
<td id="projectlogo" style="padding: 1.5em;"><a href="https://www.keil.arm.com/cmsis" target="_blank"><img alt="Logo" src="armkeil_white_h.png"/</a></td>
<td style="padding-left: 1em; padding-bottom: 1em;padding-top: 1em;">
<div id="projectname">i.MXRT105x Middleware Pack
&#160;<span id="projectnumber"><script type="text/javascript">
<!--
writeHeader.call(this);
writeVersionDropdown.call(this, "i.MXRT105x Middleware Pack");
//-->
</script>
</span>
</div>
<div id="projectbrief">MDK-Middleware examples and CMSIS-Drivers for NXP i.MXRT105x devices</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
</span>
</div>
</td>
<!--END !PROJECT_NAME-->
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<div id="CMSISnav" class="tabs1">
<ul class="tablist">
<script type="text/javascript">
writeComponentTabs.call(this);
</script>
</ul>
</div>
<!-- Generated by Doxygen 1.9.6 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
</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&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('config_pg.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">Usage instructions </div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>The <b>NXP SDK</b> is an NXP-specific software abstraction layer that provides interfaces to the device-specific peripherals. The steps to create a microcontroller application that uses MDK-Middleware and the NXP SDK are:</p><ol type="1">
<li><a class="el" href="sdk_proj.html">Create project and add software components</a></li>
<li><a class="el" href="source_files.html">Copy source files to project</a></li>
<li><a class="el" href="config_project.html">Configure the project</a></li>
<li><a class="el" href="config_pinclock.html">Configure pin and clock settings</a></li>
<li><a class="el" href="config_drivers.html">Configure CMSIS-Drivers</a></li>
<li><a class="el" href="implement_code.html">Add user code</a></li>
<li><a class="el" href="printf_retargeting.html">printf retargeting</a></li>
<li><a class="el" href="debug.html">Build and debug the application</a></li>
</ol>
<h1><a class="anchor" id="directory_spec"></a>
Assumptions</h1>
<p>The instructions assume the following:</p><ul>
<li>The device you have selected is called <code>&lt;selected_device&gt;</code>, for example <code>MIMXRT1052DVL6B</code> </li>
<li>The installation directory of this software pack is called <code>&lt;PACK_root&gt;</code>, typically <code>C:\&gt;Keil_v5\ARM\PACK\Keil\iMXRT105x_MWP\2.0.0</code></li>
<li>Your project directory is called <code>&lt;project_dir&gt;</code></li>
</ul>
<h1><a class="anchor" id="important_notes"></a>
Important notes</h1>
<p>The EVK board might be initially pre-loaded with an application which disables debug. In such case it is necessary to erase the Flash before using the board. Follow this procedure:</p><ul>
<li>Change SW7 switch position to different than initial which is: OFF, ON, ON, OFF</li>
<li>Copy the <b>CMSIS-RTOS Blinky</b> project from Pack Installer and build the <b>Release</b> target in µVision</li>
<li>Connect the USB cable to J28 connector (CMSIS-DAP)</li>
<li>Reset the board by pushing button SW4</li>
<li>In µVision, click on <b>Flash -&gt; Erase</b> soon after releasing SW4 push-button</li>
<li>After erasing of the Flash has finished, power-off the board (disconnect from J28)</li>
<li>Set switch SW7 to initial position</li>
<li>Connect USB cable to J28. The board is now ready for debugging. </li>
</ul>
</div></div><!-- contents -->
</div><!-- PageDoc -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">
<script type="text/javascript">
<!--
writeFooter.call(this);
//-->
</script>
</li>
</ul>
</div>
</body>
</html>
20 changes: 20 additions & 0 deletions v2.0.0-dev0/config_pg.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
var config_pg =
[
[ "Assumptions", "config_pg.html#directory_spec", null ],
[ "Important notes", "config_pg.html#important_notes", null ],
[ "Create project and add software components", "sdk_proj.html", null ],
[ "Copy source files to project", "source_files.html", null ],
[ "Configure the project", "config_project.html", null ],
[ "Configure I/O pins and clock", "config_pinclock.html", [
[ "Prerequisites", "config_pinclock.html#config_pinclock_pre", null ],
[ "Use the tools", "config_pinclock.html#config_pinclock_use", null ]
] ],
[ "Configure CMSIS-Drivers", "config_drivers.html", "config_drivers" ],
[ "Add user code", "implement_code.html", null ],
[ "printf retargeting", "printf_retargeting.html", null ],
[ "Build and debug the application", "debug.html", [
[ "Linker scripts for Event Recorder", "debug.html#debug_evr", null ],
[ "Build the project", "debug.html#build_prj", null ],
[ "Debug the application", "debug.html#debug_prj", null ]
] ]
];
Loading

0 comments on commit 9d9f147

Please sign in to comment.