localhorst
/
MCB1700_Welcome
1
0
Fork 0
Code Issues Pull Requests Releases Activity
MCB1700_Welcome/Doxygen/html/group__x_queue_overwrite_fr...

142 lines
8.2 KiB
HTML
Raw Permalink 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">
<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.8.20"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Labor04: xQueueOverwriteFromISR</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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Labor04
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.20 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('group__x_queue_overwrite_from_i_s_r.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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">xQueueOverwriteFromISR</div> </div>
</div><!--header-->
<div class="contents">
<p>queue. h </p><pre>
BaseType_t xQueueOverwriteFromISR(
QueueHandle_t xQueue,
const void * pvItemToQueue,
BaseType_t *pxHigherPriorityTaskWoken
);
</pre><p>A version of <a class="el" href="queue_8h.html#a8e9ced123b5a0e37a36d3bbdb2e56b4e">xQueueOverwrite()</a> that can be used in an interrupt service routine (ISR).</p>
<p>Only for use with queues that can hold a single item - so the queue is either empty or full.</p>
<p>Post an item on a queue. If the queue is already full then overwrite the value held in the queue. The item is queued by copy, not by reference.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">xQueue</td><td>The handle to the queue on which the item is to be posted.</td></tr>
<tr><td class="paramname">pvItemToQueue</td><td>A pointer to the item that is to be placed on the queue. The size of the items the queue will hold was defined when the queue was created, so this many bytes will be copied from pvItemToQueue into the queue storage area.</td></tr>
<tr><td class="paramname">pxHigherPriorityTaskWoken</td><td><a class="el" href="queue_8h.html#abdcd6a86ef82034d002193e79cfd3ce8">xQueueOverwriteFromISR()</a> will set *pxHigherPriorityTaskWoken to pdTRUE if sending to the queue caused a task to unblock, and the unblocked task has a priority higher than the currently running task. If <a class="el" href="queue_8h.html#abdcd6a86ef82034d002193e79cfd3ce8">xQueueOverwriteFromISR()</a> sets this value to pdTRUE then a context switch should be requested before the interrupt is exited.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="queue_8h.html#abdcd6a86ef82034d002193e79cfd3ce8">xQueueOverwriteFromISR()</a> is a macro that calls <a class="el" href="queue_8h.html#a263711eb0124112e828a18fd4b8ab29d">xQueueGenericSendFromISR()</a>, and therefore has the same return values as <a class="el" href="queue_8h.html#af03b83396462affe9e28302660e7b9c6">xQueueSendToFrontFromISR()</a>. However, pdPASS is the only value that can be returned because <a class="el" href="queue_8h.html#abdcd6a86ef82034d002193e79cfd3ce8">xQueueOverwriteFromISR()</a> will write to the queue even when the queue is already full.</dd></dl>
<p>Example usage: </p><pre></pre><pre> QueueHandle_t xQueue;</pre><pre> void vFunction( void *pvParameters )
{
// Create a queue to hold one uint32_t value. It is strongly
// recommended *not* to use <a class="el" href="queue_8h.html#abdcd6a86ef82034d002193e79cfd3ce8">xQueueOverwriteFromISR()</a> on queues that can
// contain more than one value, and doing so will trigger an assertion
// if <a class="el" href="_free_r_t_o_s_8h.html#a228c70cd48927d6ab730ed1a6dfbe35f">configASSERT()</a> is defined.
xQueue = xQueueCreate( 1, sizeof( uint32_t ) );
}</pre><pre>void vAnInterruptHandler( void )
{
// xHigherPriorityTaskWoken must be set to pdFALSE before it is used.
BaseType_t xHigherPriorityTaskWoken = pdFALSE;
uint32_t ulVarToSend, ulValReceived;</pre><pre> // Write the value 10 to the queue using <a class="el" href="queue_8h.html#abdcd6a86ef82034d002193e79cfd3ce8">xQueueOverwriteFromISR()</a>.
ulVarToSend = 10;
<a class="el" href="queue_8h.html#abdcd6a86ef82034d002193e79cfd3ce8">xQueueOverwriteFromISR( xQueue, &amp;ulVarToSend, &amp;xHigherPriorityTaskWoken )</a>;</pre><pre> // The queue is full, but calling <a class="el" href="queue_8h.html#abdcd6a86ef82034d002193e79cfd3ce8">xQueueOverwriteFromISR()</a> again will still
// pass because the value held in the queue will be overwritten with the
// new value.
ulVarToSend = 100;
<a class="el" href="queue_8h.html#abdcd6a86ef82034d002193e79cfd3ce8">xQueueOverwriteFromISR( xQueue, &amp;ulVarToSend, &amp;xHigherPriorityTaskWoken )</a>;</pre><pre> // Reading from the queue will now return 100.</pre><pre> // ...</pre><pre> if( xHigherPrioritytaskWoken == pdTRUE )
{
// Writing to the queue caused a task to unblock and the unblocked task
// has a priority higher than or equal to the priority of the currently
// executing task (the task this interrupt interrupted). Perform a context
// switch so this interrupt returns directly to the unblocked task.
<a class="el" href="portmacro_8h.html#aac6850c66595efdc02a8bbb95fb4648e">portYIELD_FROM_ISR()</a>; // or <a class="el" href="portmacro_8h.html#a63b994040c62c9685490a71c87a13d8a">portEND_SWITCHING_ISR()</a> depending on the port.
}
}
</pre> </div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated by <a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.8.20 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink