uofw/group__LED.html
2016-08-03 00:15:35 +00:00

324 lines
19 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"/>
<title>uOFW: LED Module</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">uOFW
</div>
<div id="projectbrief">Reverse engineered PSP kernel 6.60.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.6.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="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.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">LED Module</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSceLedConfiguration.html">SceLedConfiguration</a></td></tr>
<tr><td colspan="2"><h2><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__LED.html#gab58391378b7145044d97a0bd604072f3">ScePspLedTypes</a> { <a class="el" href="group__LED.html#ggab58391378b7145044d97a0bd604072f3af551faa3b925ccd465f41592fbab3385">PSP_LED_TYPE_MS</a> = 0,
<a class="el" href="group__LED.html#ggab58391378b7145044d97a0bd604072f3aa2e0506d10171e7309861d6982271791">PSP_LED_TYPE_WLAN</a> = 1,
<a class="el" href="group__LED.html#ggab58391378b7145044d97a0bd604072f3a9b240686bc527576146d07d3c2e58528">PSP_LED_TYPE_BT</a> = 2
}</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__LED.html#ga3ad4fc95817932bb13ee61ac417d66e6">SceLedModes</a> { <a class="el" href="group__LED.html#gga3ad4fc95817932bb13ee61ac417d66e6a6f2765c4da8e24e43e0c0217f3c26a4c">SCE_LED_MODE_OFF</a> = 0,
<a class="el" href="group__LED.html#gga3ad4fc95817932bb13ee61ac417d66e6a9d4b4423533d4d2977832fc696ad4aeb">SCE_LED_MODE_ON</a> = 1,
<a class="el" href="group__LED.html#gga3ad4fc95817932bb13ee61ac417d66e6a465f25cfa7e1d519406a2935c0709be0">SCE_LED_MODE_BLINK</a> = 2,
<a class="el" href="group__LED.html#gga3ad4fc95817932bb13ee61ac417d66e6a63edbf0842a45f36d019858b016e8b4c">SCE_LED_MODE_SELECTIVE_EXEC</a> = 3
}</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__LED.html#gabb83f25d00308a80a063a9263539eae4">SceLedCmds</a> { <br/>
&#160;&#160;<a class="el" href="group__LED.html#ggabb83f25d00308a80a063a9263539eae4abd7c3579c2d57edd2fe04a4145ecb8f1">SCE_LED_CMD_SAVE_CMD</a> = 1,
<a class="el" href="group__LED.html#ggabb83f25d00308a80a063a9263539eae4a374936b47094b28e695f7c693fbbf636">SCE_LED_CMD_EXECUTE_SAVED_CMD</a> = 2,
<a class="el" href="group__LED.html#ggabb83f25d00308a80a063a9263539eae4a4b050043fdd4eb22c7c3a9824fc3763b">SCE_LED_CMD_REGISTER_CMD</a> = 3,
<a class="el" href="group__LED.html#ggabb83f25d00308a80a063a9263539eae4a0213fd6e1bafb2d30b74ac899f96cc34">SCE_LED_CMD_EXECUTE_CMD</a> = 4,
<br/>
&#160;&#160;<a class="el" href="group__LED.html#ggabb83f25d00308a80a063a9263539eae4a749c6086c308cef753710fe39583f8ac">SCE_LED_CMD_TURN_LED_ON</a> = 16,
<a class="el" href="group__LED.html#ggabb83f25d00308a80a063a9263539eae4af59e0fbc61c70d49b5f403f99800b38f">SCE_LED_CMD_TURN_LED_OFF</a> = 17,
<a class="el" href="group__LED.html#ggabb83f25d00308a80a063a9263539eae4a8ef6877c809151821205d6cd8bc0b4cb">SCE_LED_CMD_SWITCH_LED_STATE</a> = 18,
<a class="el" href="group__LED.html#ggabb83f25d00308a80a063a9263539eae4a341857298a8265ef05a686385211aaec">SCE_LED_CMD_BLINK_LED</a> = 19
<br/>
}</td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__LED.html#gaec7059da5f5cd4655872af075dcad76f">sceLedInit</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__LED.html#gaacdc454e280c771c8bc4f65a5c07c432">sceLedEnd</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__LED.html#gae494157e15d650f9a960141d418d98dd">sceLedSetMode</a> (s32 led, s32 mode, <a class="el" href="structSceLedConfiguration.html">SceLedConfiguration</a> *config)</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<p>Hardware LED management. </p>
<hr/><h2>Enumeration Type Documentation</h2>
<a class="anchor" id="gab58391378b7145044d97a0bd604072f3"></a><!-- doxytag: member="led.h::ScePspLedTypes" ref="gab58391378b7145044d97a0bd604072f3" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__LED.html#gab58391378b7145044d97a0bd604072f3">ScePspLedTypes</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The LEDs which can be controlled via <a class="el" href="group__LED.html#gae494157e15d650f9a960141d418d98dd">sceLedSetMode()</a>. </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="ggab58391378b7145044d97a0bd604072f3af551faa3b925ccd465f41592fbab3385"></a><!-- doxytag: member="PSP_LED_TYPE_MS" ref="ggab58391378b7145044d97a0bd604072f3af551faa3b925ccd465f41592fbab3385" args="" -->PSP_LED_TYPE_MS</em>&nbsp;</td><td>
<p>Memory-Stick LED. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggab58391378b7145044d97a0bd604072f3aa2e0506d10171e7309861d6982271791"></a><!-- doxytag: member="PSP_LED_TYPE_WLAN" ref="ggab58391378b7145044d97a0bd604072f3aa2e0506d10171e7309861d6982271791" args="" -->PSP_LED_TYPE_WLAN</em>&nbsp;</td><td>
<p>W-LAN LED. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggab58391378b7145044d97a0bd604072f3a9b240686bc527576146d07d3c2e58528"></a><!-- doxytag: member="PSP_LED_TYPE_BT" ref="ggab58391378b7145044d97a0bd604072f3a9b240686bc527576146d07d3c2e58528" args="" -->PSP_LED_TYPE_BT</em>&nbsp;</td><td>
<p>Bluetooth LED. </p>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga3ad4fc95817932bb13ee61ac417d66e6"></a><!-- doxytag: member="led.h::SceLedModes" ref="ga3ad4fc95817932bb13ee61ac417d66e6" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__LED.html#ga3ad4fc95817932bb13ee61ac417d66e6">SceLedModes</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The possible LED control commands. </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="gga3ad4fc95817932bb13ee61ac417d66e6a6f2765c4da8e24e43e0c0217f3c26a4c"></a><!-- doxytag: member="SCE_LED_MODE_OFF" ref="gga3ad4fc95817932bb13ee61ac417d66e6a6f2765c4da8e24e43e0c0217f3c26a4c" args="" -->SCE_LED_MODE_OFF</em>&nbsp;</td><td>
<p>Turn a LED OFF. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="gga3ad4fc95817932bb13ee61ac417d66e6a9d4b4423533d4d2977832fc696ad4aeb"></a><!-- doxytag: member="SCE_LED_MODE_ON" ref="gga3ad4fc95817932bb13ee61ac417d66e6a9d4b4423533d4d2977832fc696ad4aeb" args="" -->SCE_LED_MODE_ON</em>&nbsp;</td><td>
<p>Turn a LED ON. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="gga3ad4fc95817932bb13ee61ac417d66e6a465f25cfa7e1d519406a2935c0709be0"></a><!-- doxytag: member="SCE_LED_MODE_BLINK" ref="gga3ad4fc95817932bb13ee61ac417d66e6a465f25cfa7e1d519406a2935c0709be0" args="" -->SCE_LED_MODE_BLINK</em>&nbsp;</td><td>
<p>Set a blink event for a LED. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="gga3ad4fc95817932bb13ee61ac417d66e6a63edbf0842a45f36d019858b016e8b4c"></a><!-- doxytag: member="SCE_LED_MODE_SELECTIVE_EXEC" ref="gga3ad4fc95817932bb13ee61ac417d66e6a63edbf0842a45f36d019858b016e8b4c" args="" -->SCE_LED_MODE_SELECTIVE_EXEC</em>&nbsp;</td><td>
<p>Register LED configuration commands and execute them. Its use is not recommended, as it is still not completely known how that mode works. </p>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gabb83f25d00308a80a063a9263539eae4"></a><!-- doxytag: member="led.h::SceLedCmds" ref="gabb83f25d00308a80a063a9263539eae4" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__LED.html#gabb83f25d00308a80a063a9263539eae4">SceLedCmds</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>LED control commands which can be passed via a <a class="el" href="structSceLedConfiguration.html">SceLedConfiguration</a> package to the system. </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="ggabb83f25d00308a80a063a9263539eae4abd7c3579c2d57edd2fe04a4145ecb8f1"></a><!-- doxytag: member="SCE_LED_CMD_SAVE_CMD" ref="ggabb83f25d00308a80a063a9263539eae4abd7c3579c2d57edd2fe04a4145ecb8f1" args="" -->SCE_LED_CMD_SAVE_CMD</em>&nbsp;</td><td>
<p>Save a LED configuration command for later use. You can only save one configuration. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggabb83f25d00308a80a063a9263539eae4a374936b47094b28e695f7c693fbbf636"></a><!-- doxytag: member="SCE_LED_CMD_EXECUTE_SAVED_CMD" ref="ggabb83f25d00308a80a063a9263539eae4a374936b47094b28e695f7c693fbbf636" args="" -->SCE_LED_CMD_EXECUTE_SAVED_CMD</em>&nbsp;</td><td>
<p>Execute a saved LED configuration command. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggabb83f25d00308a80a063a9263539eae4a4b050043fdd4eb22c7c3a9824fc3763b"></a><!-- doxytag: member="SCE_LED_CMD_REGISTER_CMD" ref="ggabb83f25d00308a80a063a9263539eae4a4b050043fdd4eb22c7c3a9824fc3763b" args="" -->SCE_LED_CMD_REGISTER_CMD</em>&nbsp;</td><td>
<p>Register a LED configuration to be executed manually by the user. Upto 4 LED configuration can be registered the same time. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggabb83f25d00308a80a063a9263539eae4a0213fd6e1bafb2d30b74ac899f96cc34"></a><!-- doxytag: member="SCE_LED_CMD_EXECUTE_CMD" ref="ggabb83f25d00308a80a063a9263539eae4a0213fd6e1bafb2d30b74ac899f96cc34" args="" -->SCE_LED_CMD_EXECUTE_CMD</em>&nbsp;</td><td>
<p>Execute the recently registered LED configuration. Once it has been executed as many times the user decided, the previously registered LED command will be executed. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggabb83f25d00308a80a063a9263539eae4a749c6086c308cef753710fe39583f8ac"></a><!-- doxytag: member="SCE_LED_CMD_TURN_LED_ON" ref="ggabb83f25d00308a80a063a9263539eae4a749c6086c308cef753710fe39583f8ac" args="" -->SCE_LED_CMD_TURN_LED_ON</em>&nbsp;</td><td>
<p>Turn ON a specified LED. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggabb83f25d00308a80a063a9263539eae4af59e0fbc61c70d49b5f403f99800b38f"></a><!-- doxytag: member="SCE_LED_CMD_TURN_LED_OFF" ref="ggabb83f25d00308a80a063a9263539eae4af59e0fbc61c70d49b5f403f99800b38f" args="" -->SCE_LED_CMD_TURN_LED_OFF</em>&nbsp;</td><td>
<p>Turn OFF a specified LED. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggabb83f25d00308a80a063a9263539eae4a8ef6877c809151821205d6cd8bc0b4cb"></a><!-- doxytag: member="SCE_LED_CMD_SWITCH_LED_STATE" ref="ggabb83f25d00308a80a063a9263539eae4a8ef6877c809151821205d6cd8bc0b4cb" args="" -->SCE_LED_CMD_SWITCH_LED_STATE</em>&nbsp;</td><td>
<p>Switch the state of an LED. ON -&gt; OFF, or OFF -&gt; ON. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggabb83f25d00308a80a063a9263539eae4a341857298a8265ef05a686385211aaec"></a><!-- doxytag: member="SCE_LED_CMD_BLINK_LED" ref="ggabb83f25d00308a80a063a9263539eae4a341857298a8265ef05a686385211aaec" args="" -->SCE_LED_CMD_BLINK_LED</em>&nbsp;</td><td>
<p>Setup a blink event for a LED. The settings for the blink event are set via the <a class="el" href="structSceLedConfiguration.html">SceLedConfiguration</a>. </p>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="gaec7059da5f5cd4655872af075dcad76f"></a><!-- doxytag: member="led.h::sceLedInit" ref="gaec7059da5f5cd4655872af075dcad76f" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u32 <a class="el" href="group__LED.html#gaec7059da5f5cd4655872af075dcad76f">sceLedInit</a> </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Initialize the LED library, enable the PSP's LEDs and turn them ON.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>SCE_ERROR_OK. </dd></dl>
</div>
</div>
<a class="anchor" id="gaacdc454e280c771c8bc4f65a5c07c432"></a><!-- doxytag: member="led.h::sceLedEnd" ref="gaacdc454e280c771c8bc4f65a5c07c432" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u32 <a class="el" href="group__LED.html#gaacdc454e280c771c8bc4f65a5c07c432">sceLedEnd</a> </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Terminate the LED library and disable the PSP's LEDs.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>SCE_ERROR_OK. </dd></dl>
</div>
</div>
<a class="anchor" id="gae494157e15d650f9a960141d418d98dd"></a><!-- doxytag: member="led.h::sceLedSetMode" ref="gae494157e15d650f9a960141d418d98dd" args="(s32 led, s32 mode, SceLedConfiguration *config)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">s32 <a class="el" href="group__LED.html#gae494157e15d650f9a960141d418d98dd">sceLedSetMode</a> </td>
<td>(</td>
<td class="paramtype">s32&#160;</td>
<td class="paramname"><em>led</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">s32&#160;</td>
<td class="paramname"><em>mode</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structSceLedConfiguration.html">SceLedConfiguration</a> *&#160;</td>
<td class="paramname"><em>config</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set a LED mode.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">led</td><td>The LED to set a mode for. One of <a class="el" href="group__LED.html#gab58391378b7145044d97a0bd604072f3">ScePspLedTypes</a>. </td></tr>
<tr><td class="paramname">mode</td><td>The mode to set for a LED. One of <a class="el" href="group__LED.html#ga3ad4fc95817932bb13ee61ac417d66e6">SceLedModes</a>. </td></tr>
<tr><td class="paramname">config</td><td>Configuration settings for a LED. Is only used for the <a class="el" href="group__LED.html#ga3ad4fc95817932bb13ee61ac417d66e6">SceLedModes</a> SCE_LED_MODE_BLINK and SCE_LED_MODE_SELECTIVE_EXEC.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>SCE_ERROR_OK on success. </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a></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>
<hr class="footer"/><address class="footer"><small>
Generated on Wed Aug 3 2016 00:15:35 for uOFW by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.6.1
</small></address>
</body>
</html>