Klagarge/Solar-Panel
Archived
1
0
Fork 0
Code Issues Pull Requests Activity
This repository has been archived on 2024-01-25. You can view files and clone it, but cannot push or open issues or pull requests.
719fdc1c14
Solar-Panel/html/eusart1_8h.html
Rémi Heredero 719fdc1c14 doxygen - main.c
2023-03-15 12:55:57 +01:00

604 lines
34 KiB
HTML
Raw Blame History

<!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.9.6"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Solar panel: mcc_generated_files/eusart1.h File Reference</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>
<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" />
</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">Solar panel
</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&amp;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&amp;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&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('eusart1_8h.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 class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle"><div class="title">eusart1.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;xc.h&gt;</code><br />
<code>#include &lt;stdbool.h&gt;</code><br />
<code>#include &lt;stdint.h&gt;</code><br />
</div>
<p><a href="eusart1_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">union &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="unioneusart1__status__t.html">eusart1_status_t</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ac49a88a0f8634c24cc1f7e2743c3fbd0"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="eusart1_8h.html#ac49a88a0f8634c24cc1f7e2743c3fbd0">EUSART1_DataReady</a>&#160;&#160;&#160;(<a class="el" href="eusart1_8c.html#a51236ea81a98a25986a6733fbf291621">EUSART1_is_rx_ready</a>())</td></tr>
<tr class="separator:ac49a88a0f8634c24cc1f7e2743c3fbd0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a17236c1d3fc2264f13ed077b4fc6973e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="eusart1_8h.html#a17236c1d3fc2264f13ed077b4fc6973e">EUSART1_Initialize</a> (void)</td></tr>
<tr class="separator:a17236c1d3fc2264f13ed077b4fc6973e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3cc9de3f3d2a8588be3bd85084011a68"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="eusart1_8h.html#a3cc9de3f3d2a8588be3bd85084011a68">EUSART1_is_tx_ready</a> (void)</td></tr>
<tr class="separator:a3cc9de3f3d2a8588be3bd85084011a68"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a51236ea81a98a25986a6733fbf291621"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="eusart1_8h.html#a51236ea81a98a25986a6733fbf291621">EUSART1_is_rx_ready</a> (void)</td></tr>
<tr class="separator:a51236ea81a98a25986a6733fbf291621"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7b5f2ddacf3a8b27a5edff78996e66f5"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="eusart1_8h.html#a7b5f2ddacf3a8b27a5edff78996e66f5">EUSART1_is_tx_done</a> (void)</td></tr>
<tr class="separator:a7b5f2ddacf3a8b27a5edff78996e66f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3dc796228d84a0c6a57dc207ed14daae"><td class="memItemLeft" align="right" valign="top"><a class="el" href="unioneusart1__status__t.html">eusart1_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="eusart1_8h.html#a3dc796228d84a0c6a57dc207ed14daae">EUSART1_get_last_status</a> (void)</td></tr>
<tr class="separator:a3dc796228d84a0c6a57dc207ed14daae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab4dd58b431d4f59c5b78f909b0b9cb0b"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="eusart1_8h.html#ab4dd58b431d4f59c5b78f909b0b9cb0b">EUSART1_Read</a> (void)</td></tr>
<tr class="separator:ab4dd58b431d4f59c5b78f909b0b9cb0b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6acb88a121ac046bf5ae77f9a3521350"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="eusart1_8h.html#a6acb88a121ac046bf5ae77f9a3521350">EUSART1_Write</a> (uint8_t txData)</td></tr>
<tr class="separator:a6acb88a121ac046bf5ae77f9a3521350"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af6867c294ab8008a59cdc81a74272669"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="eusart1_8h.html#af6867c294ab8008a59cdc81a74272669">EUSART1_Receive_ISR</a> (void)</td></tr>
<tr class="separator:af6867c294ab8008a59cdc81a74272669"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a059ef83fc11ba2fbe279fe185b0e3832"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="eusart1_8h.html#a059ef83fc11ba2fbe279fe185b0e3832">EUSART1_RxDataHandler</a> (void)</td></tr>
<tr class="separator:a059ef83fc11ba2fbe279fe185b0e3832"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa4a8db092efc718cf508792a0a521dba"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="eusart1_8h.html#aa4a8db092efc718cf508792a0a521dba">EUSART1_SetFramingErrorHandler</a> (void(*interruptHandler)(void))</td></tr>
<tr class="separator:aa4a8db092efc718cf508792a0a521dba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8129057b0391bb8de6fa1058057c589e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="eusart1_8h.html#a8129057b0391bb8de6fa1058057c589e">EUSART1_SetOverrunErrorHandler</a> (void(*interruptHandler)(void))</td></tr>
<tr class="separator:a8129057b0391bb8de6fa1058057c589e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1ce96cef41cc2e985c8a600873f3d688"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="eusart1_8h.html#a1ce96cef41cc2e985c8a600873f3d688">EUSART1_SetErrorHandler</a> (void(*interruptHandler)(void))</td></tr>
<tr class="separator:a1ce96cef41cc2e985c8a600873f3d688"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a66a557ddf06eda003b454c56b5f6fa2b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="eusart1_8h.html#a66a557ddf06eda003b454c56b5f6fa2b">EUSART1_SetRxInterruptHandler</a> (void(*interruptHandler)(void))</td></tr>
<tr class="separator:a66a557ddf06eda003b454c56b5f6fa2b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a60e1cd80da2c5389aa7458e8af1a651a"><td class="memItemLeft" align="right" valign="top">volatile uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="eusart1_8h.html#a60e1cd80da2c5389aa7458e8af1a651a">eusart1TxBufferRemaining</a></td></tr>
<tr class="separator:a60e1cd80da2c5389aa7458e8af1a651a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab6e9a7238b7754678619a44374419718"><td class="memItemLeft" align="right" valign="top">volatile uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="eusart1_8h.html#ab6e9a7238b7754678619a44374419718">eusart1RxCount</a></td></tr>
<tr class="separator:ab6e9a7238b7754678619a44374419718"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a880bcfd3bf2ca46fd0f4a14b2a0a3b9d"><td class="memItemLeft" align="right" valign="top">void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="eusart1_8h.html#a880bcfd3bf2ca46fd0f4a14b2a0a3b9d">EUSART1_RxDefaultInterruptHandler</a> )(void)</td></tr>
<tr class="separator:a880bcfd3bf2ca46fd0f4a14b2a0a3b9d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="ac49a88a0f8634c24cc1f7e2743c3fbd0" name="ac49a88a0f8634c24cc1f7e2743c3fbd0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac49a88a0f8634c24cc1f7e2743c3fbd0">&#9670;&#160;</a></span>EUSART1_DataReady</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define EUSART1_DataReady&#160;&#160;&#160;(<a class="el" href="eusart1_8c.html#a51236ea81a98a25986a6733fbf291621">EUSART1_is_rx_ready</a>())</td>
</tr>
</table>
</div><div class="memdoc">
<p>EUSART1 Generated Driver API Header File</p>
<p>@Company Microchip Technology Inc.</p>
<p>@File Name <a class="el" href="eusart1_8h.html">eusart1.h</a></p>
<p>@Summary This is the generated header file for the EUSART1 driver using PIC10 / PIC12 / PIC16 / PIC18 MCUs</p>
<p>@Description This header file provides APIs for driver for EUSART1. Generation Information : Product Revision : PIC10 / PIC12 / PIC16 / PIC18 MCUs - 1.81.8 Device : PIC18F97J60 Driver Version : 2.1.1 The generated drivers are tested against the following: Compiler : XC8 2.36 and above MPLAB : MPLAB X 6.00 Section: Included Files Section: Macro Declarations </p>
<p class="definition">Definition at line <a class="el" href="eusart1_8h_source.html#l00069">69</a> of file <a class="el" href="eusart1_8h_source.html">eusart1.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a3dc796228d84a0c6a57dc207ed14daae" name="a3dc796228d84a0c6a57dc207ed14daae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3dc796228d84a0c6a57dc207ed14daae">&#9670;&#160;</a></span>EUSART1_get_last_status()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="unioneusart1__status__t.html">eusart1_status_t</a> EUSART1_get_last_status </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>@Summary Gets the error status of the last read byte.</p>
<p>@Description This routine gets the error status of the last read byte.</p>
<p>@Preconditions <a class="el" href="eusart1_8h.html#a17236c1d3fc2264f13ed077b4fc6973e">EUSART1_Initialize()</a> function should have been called before calling this function. The returned value is only updated after a read is called.</p>
<p>@Param None</p>
<p>@Returns the status of the last read byte</p>
<p>@Example <code> void <a class="el" href="main_8c.html#a6288eba0f8e8ad3ab1544ad731eb7667">main(void)</a> { volatile uint8_t rxData; volatile <a class="el" href="unioneusart1__status__t.html">eusart1_status_t</a> rxStatus;</code></p>
<p><code>Initialize the device <a class="el" href="mcc_8c.html#a5e8391114a0cf91ac20002be25e3d352">SYSTEM_Initialize()</a>;</code></p>
<p><code>Enable the Global Interrupts <a class="el" href="interrupt__manager_8h.html#ab801e88ce18e2d200429ffbaa67dbf2b">INTERRUPT_GlobalInterruptEnable()</a>;</code></p>
<p><code> while(1) { Logic to echo received data if(EUSART1_is_rx_ready()) { rxData = <a class="el" href="eusart1_8h.html#ab4dd58b431d4f59c5b78f909b0b9cb0b">EUSART1_Read()</a>; rxStatus = <a class="el" href="eusart1_8h.html#a3dc796228d84a0c6a57dc207ed14daae">EUSART1_get_last_status()</a>; if(rxStatus.ferr){ LED_0_SetHigh(); } } } } </code> </p>
<p class="definition">Definition at line <a class="el" href="eusart1_8c_source.html#l00136">136</a> of file <a class="el" href="eusart1_8c_source.html">eusart1.c</a>.</p>
</div>
</div>
<a id="a17236c1d3fc2264f13ed077b4fc6973e" name="a17236c1d3fc2264f13ed077b4fc6973e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a17236c1d3fc2264f13ed077b4fc6973e">&#9670;&#160;</a></span>EUSART1_Initialize()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void EUSART1_Initialize </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>@Summary Initialization routine that takes inputs from the EUSART1 GUI.</p>
<p>@Description This routine initializes the EUSART1 driver. This routine must be called before any other EUSART1 routine is called.</p>
<p>@Preconditions None</p>
<p>@Param None</p>
<p>@Returns None</p>
<p>@Comment </p>
<p class="definition">Definition at line <a class="el" href="eusart1_8c_source.html#l00083">83</a> of file <a class="el" href="eusart1_8c_source.html">eusart1.c</a>.</p>
</div>
</div>
<a id="a51236ea81a98a25986a6733fbf291621" name="a51236ea81a98a25986a6733fbf291621"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a51236ea81a98a25986a6733fbf291621">&#9670;&#160;</a></span>EUSART1_is_rx_ready()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool EUSART1_is_rx_ready </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>@Summary Checks if the EUSART1 receiver ready for reading</p>
<p>@Description This routine checks if EUSART1 receiver has received data and ready to be read</p>
<p>@Preconditions <a class="el" href="eusart1_8h.html#a17236c1d3fc2264f13ed077b4fc6973e">EUSART1_Initialize()</a> function should be called before calling this function EUSART1 receiver should be enabled before calling this function</p>
<p>@Param None</p>
<p>@Returns Status of EUSART1 receiver TRUE: EUSART1 receiver is ready for reading FALSE: EUSART1 receiver is not ready for reading</p>
<p>@Example <code> void <a class="el" href="main_8c.html#a6288eba0f8e8ad3ab1544ad731eb7667">main(void)</a> { volatile uint8_t rxData;</code></p>
<p><code>Initialize the device <a class="el" href="mcc_8c.html#a5e8391114a0cf91ac20002be25e3d352">SYSTEM_Initialize()</a>;</code></p>
<p><code> while(1) { Logic to echo received data if(EUSART1_is_rx_ready()) { rxData = UART1_Read(); if(EUSART1_is_tx_ready()) { EUSART1_Write(rxData); } } } } </code> </p>
<p class="definition">Definition at line <a class="el" href="eusart1_8c_source.html#l00126">126</a> of file <a class="el" href="eusart1_8c_source.html">eusart1.c</a>.</p>
</div>
</div>
<a id="a7b5f2ddacf3a8b27a5edff78996e66f5" name="a7b5f2ddacf3a8b27a5edff78996e66f5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7b5f2ddacf3a8b27a5edff78996e66f5">&#9670;&#160;</a></span>EUSART1_is_tx_done()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool EUSART1_is_tx_done </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>@Summary Checks if EUSART1 data is transmitted</p>
<p>@Description This function return the status of transmit shift register</p>
<p>@Preconditions <a class="el" href="eusart1_8h.html#a17236c1d3fc2264f13ed077b4fc6973e">EUSART1_Initialize()</a> function should be called before calling this function EUSART1 transmitter should be enabled and EUSART1_Write should be called before calling this function</p>
<p>@Param None</p>
<p>@Returns Status of EUSART1 receiver TRUE: Data completely shifted out if the USART shift register FALSE: Data is not completely shifted out of the shift register</p>
<p>@Example <code> void <a class="el" href="main_8c.html#a6288eba0f8e8ad3ab1544ad731eb7667">main(void)</a> { volatile uint8_t rxData;</code></p>
<p><code>Initialize the device <a class="el" href="mcc_8c.html#a5e8391114a0cf91ac20002be25e3d352">SYSTEM_Initialize()</a>;</code></p>
<p><code> while(1) { if(EUSART1_is_tx_ready()) { LED_0_SetHigh(); EUSART1Write(rxData); } if(<a class="el" href="eusart1_8h.html#a7b5f2ddacf3a8b27a5edff78996e66f5">EUSART1_is_tx_done()</a> { LED_0_SetLow(); } } } </code> </p>
<p class="definition">Definition at line <a class="el" href="eusart1_8c_source.html#l00131">131</a> of file <a class="el" href="eusart1_8c_source.html">eusart1.c</a>.</p>
</div>
</div>
<a id="a3cc9de3f3d2a8588be3bd85084011a68" name="a3cc9de3f3d2a8588be3bd85084011a68"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3cc9de3f3d2a8588be3bd85084011a68">&#9670;&#160;</a></span>EUSART1_is_tx_ready()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool EUSART1_is_tx_ready </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>@Summary Checks if the EUSART1 transmitter is ready to transmit data</p>
<p>@Description This routine checks if EUSART1 transmitter is ready to accept and transmit data byte</p>
<p>@Preconditions <a class="el" href="eusart1_8h.html#a17236c1d3fc2264f13ed077b4fc6973e">EUSART1_Initialize()</a> function should have been called before calling this function. EUSART1 transmitter should be enabled before calling this function</p>
<p>@Param None</p>
<p>@Returns Status of EUSART1 transmitter TRUE: EUSART1 transmitter is ready FALSE: EUSART1 transmitter is not ready</p>
<p>@Example <code> void <a class="el" href="main_8c.html#a6288eba0f8e8ad3ab1544ad731eb7667">main(void)</a> { volatile uint8_t rxData;</code></p>
<p><code>Initialize the device <a class="el" href="mcc_8c.html#a5e8391114a0cf91ac20002be25e3d352">SYSTEM_Initialize()</a>;</code></p>
<p><code> while(1) { Logic to echo received data if(EUSART1_is_rx_ready()) { rxData = UART1_Read(); if(EUSART1_is_tx_ready()) { EUSART1Write(rxData); } } } } </code> </p>
<p class="definition">Definition at line <a class="el" href="eusart1_8c_source.html#l00121">121</a> of file <a class="el" href="eusart1_8c_source.html">eusart1.c</a>.</p>
</div>
</div>
<a id="ab4dd58b431d4f59c5b78f909b0b9cb0b" name="ab4dd58b431d4f59c5b78f909b0b9cb0b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab4dd58b431d4f59c5b78f909b0b9cb0b">&#9670;&#160;</a></span>EUSART1_Read()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t EUSART1_Read </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>@Summary Read a byte of data from the EUSART1.</p>
<p>@Description This routine reads a byte of data from the EUSART1.</p>
<p>@Preconditions <a class="el" href="eusart1_8h.html#a17236c1d3fc2264f13ed077b4fc6973e">EUSART1_Initialize()</a> function should have been called before calling this function. The transfer status should be checked to see if the receiver is not empty before calling this function.</p>
<p>@Param None</p>
<p>@Returns A data byte received by the driver. </p>
<p class="definition">Definition at line <a class="el" href="eusart1_8c_source.html#l00140">140</a> of file <a class="el" href="eusart1_8c_source.html">eusart1.c</a>.</p>
</div>
</div>
<a id="af6867c294ab8008a59cdc81a74272669" name="af6867c294ab8008a59cdc81a74272669"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af6867c294ab8008a59cdc81a74272669">&#9670;&#160;</a></span>EUSART1_Receive_ISR()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void EUSART1_Receive_ISR </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>@Summary Maintains the driver's receiver state machine and implements its ISR</p>
<p>@Description This routine is used to maintain the driver's internal receiver state machine.This interrupt service routine is called when the state of the receiver needs to be maintained in a non polled manner.</p>
<p>@Preconditions <a class="el" href="eusart1_8h.html#a17236c1d3fc2264f13ed077b4fc6973e">EUSART1_Initialize()</a> function should have been called for the ISR to execute correctly.</p>
<p>@Param None</p>
<p>@Returns None </p>
<p class="definition">Definition at line <a class="el" href="eusart1_8c_source.html#l00173">173</a> of file <a class="el" href="eusart1_8c_source.html">eusart1.c</a>.</p>
</div>
</div>
<a id="a059ef83fc11ba2fbe279fe185b0e3832" name="a059ef83fc11ba2fbe279fe185b0e3832"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a059ef83fc11ba2fbe279fe185b0e3832">&#9670;&#160;</a></span>EUSART1_RxDataHandler()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void EUSART1_RxDataHandler </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>@Summary Maintains the driver's receiver state machine</p>
<p>@Description This routine is called by the receive state routine and is used to maintain the driver's internal receiver state machine. It should be called by a custom ISR to maintain normal behavior</p>
<p>@Preconditions <a class="el" href="eusart1_8h.html#a17236c1d3fc2264f13ed077b4fc6973e">EUSART1_Initialize()</a> function should have been called for the ISR to execute correctly.</p>
<p>@Param None</p>
<p>@Returns None </p>
<p class="definition">Definition at line <a class="el" href="eusart1_8c_source.html#l00197">197</a> of file <a class="el" href="eusart1_8c_source.html">eusart1.c</a>.</p>
</div>
</div>
<a id="a1ce96cef41cc2e985c8a600873f3d688" name="a1ce96cef41cc2e985c8a600873f3d688"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1ce96cef41cc2e985c8a600873f3d688">&#9670;&#160;</a></span>EUSART1_SetErrorHandler()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void EUSART1_SetErrorHandler </td>
<td>(</td>
<td class="paramtype">void(*)(void)&#160;</td>
<td class="paramname"><em>interruptHandler</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>@Summary Set EUSART1 Error Handler</p>
<p>@Description This API sets the function to be called upon EUSART1 error</p>
<p>@Preconditions Initialize the EUSART1 module before calling this API</p>
<p>@Param Address of function to be set as error handler</p>
<p>@Returns None </p>
<p class="definition">Definition at line <a class="el" href="eusart1_8c_source.html#l00229">229</a> of file <a class="el" href="eusart1_8c_source.html">eusart1.c</a>.</p>
</div>
</div>
<a id="aa4a8db092efc718cf508792a0a521dba" name="aa4a8db092efc718cf508792a0a521dba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa4a8db092efc718cf508792a0a521dba">&#9670;&#160;</a></span>EUSART1_SetFramingErrorHandler()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void EUSART1_SetFramingErrorHandler </td>
<td>(</td>
<td class="paramtype">void(*)(void)&#160;</td>
<td class="paramname"><em>interruptHandler</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>@Summary Set EUSART1 Framing Error Handler</p>
<p>@Description This API sets the function to be called upon EUSART1 framing error</p>
<p>@Preconditions Initialize the EUSART1 before calling this API</p>
<p>@Param Address of function to be set as framing error handler</p>
<p>@Returns None </p>
<p class="definition">Definition at line <a class="el" href="eusart1_8c_source.html#l00221">221</a> of file <a class="el" href="eusart1_8c_source.html">eusart1.c</a>.</p>
</div>
</div>
<a id="a8129057b0391bb8de6fa1058057c589e" name="a8129057b0391bb8de6fa1058057c589e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8129057b0391bb8de6fa1058057c589e">&#9670;&#160;</a></span>EUSART1_SetOverrunErrorHandler()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void EUSART1_SetOverrunErrorHandler </td>
<td>(</td>
<td class="paramtype">void(*)(void)&#160;</td>
<td class="paramname"><em>interruptHandler</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>@Summary Set EUSART1 Overrun Error Handler</p>
<p>@Description This API sets the function to be called upon EUSART1 overrun error</p>
<p>@Preconditions Initialize the EUSART1 module before calling this API</p>
<p>@Param Address of function to be set as overrun error handler</p>
<p>@Returns None </p>
<p class="definition">Definition at line <a class="el" href="eusart1_8c_source.html#l00225">225</a> of file <a class="el" href="eusart1_8c_source.html">eusart1.c</a>.</p>
</div>
</div>
<a id="a66a557ddf06eda003b454c56b5f6fa2b" name="a66a557ddf06eda003b454c56b5f6fa2b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a66a557ddf06eda003b454c56b5f6fa2b">&#9670;&#160;</a></span>EUSART1_SetRxInterruptHandler()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void EUSART1_SetRxInterruptHandler </td>
<td>(</td>
<td class="paramtype">void(*)(void)&#160;</td>
<td class="paramname"><em>interruptHandler</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>@Summary Sets the receive handler function to be called by the interrupt service</p>
<p>@Description Calling this function will set a new custom function that will be called when the receive interrupt needs servicing.</p>
<p>@Preconditions <a class="el" href="eusart1_8h.html#a17236c1d3fc2264f13ed077b4fc6973e">EUSART1_Initialize()</a> function should have been called for the ISR to execute correctly.</p>
<p>@Param A pointer to the new function</p>
<p>@Returns None </p>
<p class="definition">Definition at line <a class="el" href="eusart1_8c_source.html#l00234">234</a> of file <a class="el" href="eusart1_8c_source.html">eusart1.c</a>.</p>
</div>
</div>
<a id="a6acb88a121ac046bf5ae77f9a3521350" name="a6acb88a121ac046bf5ae77f9a3521350"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6acb88a121ac046bf5ae77f9a3521350">&#9670;&#160;</a></span>EUSART1_Write()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void EUSART1_Write </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>txData</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>@Summary Writes a byte of data to the EUSART1.</p>
<p>@Description This routine writes a byte of data to the EUSART1.</p>
<p>@Preconditions <a class="el" href="eusart1_8h.html#a17236c1d3fc2264f13ed077b4fc6973e">EUSART1_Initialize()</a> function should have been called before calling this function. The transfer status should be checked to see if transmitter is not busy before calling this function.</p>
<p>@Param txData - Data byte to write to the EUSART1</p>
<p>@Returns None </p>
<p class="definition">Definition at line <a class="el" href="eusart1_8c_source.html#l00162">162</a> of file <a class="el" href="eusart1_8c_source.html">eusart1.c</a>.</p>
</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a id="a880bcfd3bf2ca46fd0f4a14b2a0a3b9d" name="a880bcfd3bf2ca46fd0f4a14b2a0a3b9d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a880bcfd3bf2ca46fd0f4a14b2a0a3b9d">&#9670;&#160;</a></span>EUSART1_RxDefaultInterruptHandler</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void(* EUSART1_RxDefaultInterruptHandler) (void) </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">extern</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Section: EUSART1 APIs </p>
<p class="definition">Definition at line <a class="el" href="eusart1_8c_source.html#l00073">73</a> of file <a class="el" href="eusart1_8c_source.html">eusart1.c</a>.</p>
</div>
</div>
<a id="ab6e9a7238b7754678619a44374419718" name="ab6e9a7238b7754678619a44374419718"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab6e9a7238b7754678619a44374419718">&#9670;&#160;</a></span>eusart1RxCount</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">volatile uint8_t eusart1RxCount</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">extern</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="eusart1_8c_source.html#l00067">67</a> of file <a class="el" href="eusart1_8c_source.html">eusart1.c</a>.</p>
</div>
</div>
<a id="a60e1cd80da2c5389aa7458e8af1a651a" name="a60e1cd80da2c5389aa7458e8af1a651a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a60e1cd80da2c5389aa7458e8af1a651a">&#9670;&#160;</a></span>eusart1TxBufferRemaining</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">volatile uint8_t eusart1TxBufferRemaining</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">extern</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Section: Global variables </p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_0ad8aa10ae8c15a00cc43e117933779f.html">mcc_generated_files</a></li><li class="navelem"><a class="el" href="eusart1_8h.html">eusart1.h</a></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.9.6 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink