209 lines
20 KiB
HTML
209 lines
20 KiB
HTML
<!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="generator" content="Doxygen 1.14.0"/>
|
||
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||
<title>MyLibs: E:/.WORK/STM32/STM32_ExtendedLibs/mainpage.h Source File</title>
|
||
<link href="tabs.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="clipboard.js"></script>
|
||
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
||
<script type="text/javascript" src="navtreedata.js"></script>
|
||
<script type="text/javascript" src="navtree.js"></script>
|
||
<script type="text/javascript" src="cookie.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/x-mathjax-config">
|
||
MathJax.Hub.Config({
|
||
extensions: ["tex2jax.js"],
|
||
jax: ["input/TeX","output/HTML-CSS"],
|
||
});
|
||
</script>
|
||
<script type="text/javascript" async="async" src="https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js"></script>
|
||
<script type="text/javascript" src="darkmode_toggle.js"></script>
|
||
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
||
</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 id="projectrow">
|
||
<td id="projectalign">
|
||
<div id="projectname">MyLibs<span id="projectnumber"> 1.0</span>
|
||
</div>
|
||
<div id="projectbrief">Расширенные библиотеки для STM32</div>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<!-- end header part -->
|
||
<!-- Generated by Doxygen 1.14.0 -->
|
||
<script type="text/javascript">
|
||
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
||
</script>
|
||
<script type="text/javascript">
|
||
$(function() { codefold.init(); });
|
||
</script>
|
||
<script type="text/javascript" src="menudata.js"></script>
|
||
<script type="text/javascript" src="menu.js"></script>
|
||
<script type="text/javascript">
|
||
$(function() {
|
||
initMenu('',true,false,'search.php','Search',true);
|
||
$(function() { init_search(); });
|
||
});
|
||
</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">
|
||
$(function(){initNavTree('mainpage_8h_source.html','',''); });
|
||
</script>
|
||
<div id="container">
|
||
<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 class="header">
|
||
<div class="headertitle"><div class="title">E:/.WORK/STM32/STM32_ExtendedLibs/mainpage.h</div></div>
|
||
</div><!--header-->
|
||
<div class="contents">
|
||
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/**</span></div>
|
||
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment">@mainpage</span></div>
|
||
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"></span> </div>
|
||
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> </span></div>
|
||
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment">@section overview Обзор</span></div>
|
||
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment">MyLibs - это набор библиотек для удобной работы с STM32.</span></div>
|
||
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"></span> </div>
|
||
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment">\htmlonly</span></div>
|
||
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"><a href="https://git.arktika.cyou/Razvalyaev/STM32_ExtendedLibs/src/branch/release">Актуальная версия</a></span></div>
|
||
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment">\endhtmlonly</span></div>
|
||
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"></span> </div>
|
||
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment">@subsection features Основные возможности</span></div>
|
||
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"></span> </div>
|
||
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment">@subsubsection utils_module Общие утилиты (@ref MYLIBS_DEFINES)</span></div>
|
||
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment">- Макросы для задержек и утилит (@ref DELAYS_DEFINES и @ref UTILS_DEFINES)</span></div>
|
||
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment">- Трекеры для статистики и отладки (@ref TRACKERS и @ref TRACE)</span></div>
|
||
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment">- Эволюционный алгоритм для оптимизации параметров (@ref GEN_OPTIMIZER)</span></div>
|
||
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment">- Битовый доступ к регистрам через union (@ref BIT_ACCESS_DEFINES)</span></div>
|
||
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="comment"></span> </div>
|
||
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="comment">@subsubsection trace_module Трассировка @ref TRACE</span></div>
|
||
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="comment">- Serial трассировка через SWO и RTT (@ref TRACE_SERIAL)</span></div>
|
||
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="comment">- GPIO трассировка для отладки (@ref TRACE_GPIO)</span></div>
|
||
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="comment">- Сохранение логов в Flash память (@ref TRACE_RTT_FLASH)</span></div>
|
||
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="comment">- Обработка HardFault с сохранением контекста (@ref TRACE_HARDFAULT)</span></div>
|
||
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="comment"></span> </div>
|
||
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="comment">@subsubsection gpio_module Модуль GPIO @ref MY_LIBS_GPIO</span></div>
|
||
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="comment">- Инициализация портов и тактирования (@ref MYLIBS_GPIO_GENERAL)</span></div>
|
||
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="comment">- Управление светодиодами (включение/выключение, моргание, плавное затухание) (@ref MYLIBS_GPIO_LEDS)</span></div>
|
||
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="comment">- Работа с кнопками (чтение состояния, фильтрация дребезга) (@ref MYLIBS_GPIO_SWITCH)</span></div>
|
||
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="comment"></span> </div>
|
||
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="comment">@subsubsection tim_module Модуль таймеров @ref MY_LIBS_TIM</span></div>
|
||
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="comment">- Базовая инициализация таймеров (@ref MYLIBS_TIM_GENERAL)</span></div>
|
||
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="comment">- Формирование задержек (блокирующие и неблокирующие) (@ref MYLIBS_TIM_DELAY)</span></div>
|
||
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="comment">- Работа с энкодерами (чтение положения, обработка кнопок) (@ref MYLIBS_TIM_ENCODER)</span></div>
|
||
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="comment">- Настройка ШИМ и Output Compare (@ref MYLIBS_TIM_OC)</span></div>
|
||
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span><span class="comment"></span> </div>
|
||
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span><span class="comment">@subsubsection uart_module Модуль UART @ref MY_LIBS_UART</span></div>
|
||
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span><span class="comment">- Базовая инициализация UART и его пинов одной функцией (@ref UART_Base_Init)</span></div>
|
||
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span><span class="comment"></span> </div>
|
||
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span><span class="comment">@subsubsection spi_module Модуль SPI @ref MY_LIBS_SPI</span></div>
|
||
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span><span class="comment">- Базовая инициализация SPI и пинов одной функцией (@ref SPI_Base_Init)</span></div>
|
||
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span><span class="comment"></span> </div>
|
||
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span><span class="comment">@subsection structure Структура проекта</span></div>
|
||
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span><span class="comment"></span> </div>
|
||
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span><span class="comment">@code</span></div>
|
||
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span><span class="comment">ProjectRoot/</span></div>
|
||
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span><span class="comment">├── MyLibs/ # Общие библиотеки, независимые от платформы (или почти)</span></div>
|
||
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span><span class="comment">│ ├── inc/</span></div>
|
||
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span><span class="comment">│ │ ├── mylibs_include.h # Главный include файл</span></div>
|
||
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span><span class="comment">│ │ ├── mylibs_config.h # Конфигурация библиотек</span></div>
|
||
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span><span class="comment">│ │ ├── mylibs_defs.h # Общие определения и макросы</span></div>
|
||
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span><span class="comment">│ │ ├── bit_access.h # Битовый доступ к регистрам</span></div>
|
||
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span><span class="comment">│ │ ├── gen_optimizer.h # Оптимизатор (генетический алгоритм)</span></div>
|
||
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span><span class="comment">│ │ ├── trackers.h # Трекеры для отладки</span></div>
|
||
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span><span class="comment">│ │ └── trace.h # Трассировка и логирование</span></div>
|
||
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span><span class="comment">│ └── src/</span></div>
|
||
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span><span class="comment">│</span></div>
|
||
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span><span class="comment">├──RTT # Библиотека RTT</span></div>
|
||
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span><span class="comment">│ ├── __SEGGER_RTT_Conf.h # Конфигурационный файл RTT</span></div>
|
||
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span><span class="comment">│ ├── SEGGER_RTT.c # Основной модуль RTT</span></div>
|
||
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span><span class="comment">│ ├── SEGGER_RTT.h # Основной заголовок RTT</span></div>
|
||
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span><span class="comment">│ ├── SEGGER_RTT_ASM_ARMv7M.S # Ассемблерная оптимизация для ARMv7M</span></div>
|
||
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span><span class="comment">│ └── SEGGER_RTT_printf.c # Реализация printf() через RTT</span></div>
|
||
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span><span class="comment">│</span></div>
|
||
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span><span class="comment">└── STM32_General # Работа с периферией STM32</span></div>
|
||
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span><span class="comment"> ├── inc/</span></div>
|
||
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span><span class="comment"> │ ├── general_gpio.h # Работа с GPIO</span></div>
|
||
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span><span class="comment"> │ ├── general_spi.h # Работа с SPI</span></div>
|
||
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span><span class="comment"> │ ├── general_tim.h # Работа с таймерами</span></div>
|
||
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span><span class="comment"> │ └── general_uart.h # Работа с UART</span></div>
|
||
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span><span class="comment"> └── src/</span></div>
|
||
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span><span class="comment"> ├── general_gpio.c # Реализация GPIO</span></div>
|
||
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span><span class="comment"> ├── general_spi.c # Реализация SPI</span></div>
|
||
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span><span class="comment"> ├── general_tim.c # Реализация TIM</span></div>
|
||
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span><span class="comment"> └── general_uart.c # Реализация UART</span></div>
|
||
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span><span class="comment">@endcode</span></div>
|
||
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span><span class="comment"></span> </div>
|
||
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span><span class="comment"></span> </div>
|
||
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span><span class="comment"></span> </div>
|
||
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span><span class="comment"></span> </div>
|
||
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span><span class="comment">@subsection usage_basic Использование</span></div>
|
||
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span><span class="comment"></span> </div>
|
||
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span><span class="comment">Инструкция по подключению:</span></div>
|
||
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span><span class="comment"></span> </div>
|
||
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span><span class="comment">1. Настройте конфигурацию @ref MYLIBS_CONFIG в @ref mylibs_config.h </span></div>
|
||
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span><span class="comment"></span> </div>
|
||
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span><span class="comment">2. Подключите главный заголовочный файл:</span></div>
|
||
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span><span class="comment">@code</span></div>
|
||
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span><span class="comment">#include "mylibs_include.h"</span></div>
|
||
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span><span class="comment">@endcode</span></div>
|
||
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span><span class="comment"></span> </div>
|
||
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span><span class="comment">3. Используйте нужные модули в своем коде. Примеры использования приведены в соответствующей теме</span></div>
|
||
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span><span class="comment"></span> </div>
|
||
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span><span class="comment">*/</span></div>
|
||
</div><!-- fragment --></div><!-- contents -->
|
||
</div><!-- doc-content -->
|
||
</div><!-- container -->
|
||
<!-- start footer part -->
|
||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||
<ul>
|
||
<li class="navelem"><b>mainpage.h</b></li>
|
||
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.14.0 </li>
|
||
</ul>
|
||
</div>
|
||
</body>
|
||
</html>
|