USB_Host_Shield_2.0/_p_s5_trigger_8h_source.html
2021-03-23 11:43:48 +00:00

193 lines
21 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">
<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.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>USB Host Shield 2.0: PS5Trigger.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>
<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" />
<link href="imageStyle.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">USB Host Shield 2.0
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<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 -->
<!-- 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">PS5Trigger.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="_p_s5_trigger_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160; </div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="preprocessor">#ifndef _ps5trigger_h_</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="preprocessor">#define _ps5trigger_h_</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; </div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="preprocessor">#include &lt;inttypes.h&gt;</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; </div>
<div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="class_p_s5_trigger.html"> 38</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_p_s5_trigger.html">PS5Trigger</a> {</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="comment">// Type of trigger effect</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="keyword">typedef</span> <span class="keyword">enum</span> _EffectType : uint8_t {</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; NoResitance = 0x00, <span class="comment">// No resistance is applied</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; ContinuousResitance = 0x01, <span class="comment">// Continuous Resitance is applied</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; SectionResitance = 0x02, <span class="comment">// Seciton resistance is appleyed</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; EffectEx = 0x26, <span class="comment">// Extended trigger effect</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; Calibrate = 0xFC, <span class="comment">// Calibrate triggers</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; } EffectType;</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; </div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="comment">// Trigger effect</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <span class="keyword">typedef</span> <span class="keyword">struct </span>_EffectData {</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="comment">// Trigger effect type</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; EffectType effectType;</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; </div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <span class="comment">// Union for effect parameters</span></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <span class="keyword">union </span>{</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <span class="comment">// Union one raw data</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; uint8_t _u1_raw[6];</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; </div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <span class="comment">// For type == ContinuousResitance</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; <span class="keyword">struct </span>{</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; uint8_t startPosition; <span class="comment">// Start position of resistance</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; uint8_t force; <span class="comment">// Force of resistance</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; uint8_t _pad[4]; <span class="comment">// PAD / UNUSED</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; } __attribute__((packed)) Continuous;</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; </div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <span class="comment">// For type == SectionResitance</span></div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; <span class="keyword">struct </span>{</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; uint8_t startPosition; <span class="comment">// Start position of resistance</span></div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; uint8_t endPosition; <span class="comment">// End position of resistance (&gt;= start)</span></div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; uint8_t _pad[4]; <span class="comment">// PAD / UNUSED</span></div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; } __attribute__((packed)) Section;</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; </div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; <span class="comment">// For type == EffectEx</span></div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; <span class="keyword">struct </span>{</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; uint8_t startPosition; <span class="comment">// Position at witch the effect starts</span></div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; <span class="keywordtype">bool</span> keepEffect; <span class="comment">// Wher the effect should keep playing when trigger goes beyond 255</span></div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; uint8_t beginForce; <span class="comment">// Force applied when trigger &gt;= (255 / 2)</span></div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; uint8_t middleForce; <span class="comment">// Force applied when trigger &lt;= (255 / 2)</span></div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; uint8_t endForce; <span class="comment">// Force applied when trigger is beyond 255</span></div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; uint8_t frequency; <span class="comment">// Vibration frequency of the trigger</span></div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; } __attribute__((packed)) EffectEx;</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; } __attribute__((packed));</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; } __attribute__((packed)) EffectData;</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; </div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; EffectData data;</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; </div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00088"></a><span class="lineno"><a class="line" href="class_p_s5_trigger.html#ae0267c7b60ebb176c54a42072647a866"> 88</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_p_s5_trigger.html#ae0267c7b60ebb176c54a42072647a866">reportChanged</a> = <span class="keyword">false</span>;</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; </div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_p_s5_trigger.html#a5cf79bb95535c3c540ef698921989691">processTrigger</a>(uint8_t* buffer);</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; </div>
<div class="line"><a name="l00100"></a><span class="lineno"><a class="line" href="class_p_s5_trigger.html#ad537a2d55a7d131e89e4257f015b741e"> 100</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_p_s5_trigger.html#ad537a2d55a7d131e89e4257f015b741e">Reset</a>() {</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; data.effectType = EffectType::NoResitance;</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; </div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; <a class="code" href="class_p_s5_trigger.html#ae0267c7b60ebb176c54a42072647a866">reportChanged</a> = <span class="keyword">false</span>;</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; };</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; </div>
<div class="line"><a name="l00109"></a><span class="lineno"><a class="line" href="class_p_s5_trigger.html#a4d5e773112d91bdae5163fc23fef53d9"> 109</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_p_s5_trigger.html#a4d5e773112d91bdae5163fc23fef53d9">clearTriggerForce</a>() {</div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; data.effectType = EffectType::NoResitance;</div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; </div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; <a class="code" href="class_p_s5_trigger.html#ae0267c7b60ebb176c54a42072647a866">reportChanged</a> = <span class="keyword">true</span>;</div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; };</div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; </div>
<div class="line"><a name="l00120"></a><span class="lineno"><a class="line" href="class_p_s5_trigger.html#a2ba3108980ad8e51c687f8b46f25d804"> 120</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_p_s5_trigger.html#a2ba3108980ad8e51c687f8b46f25d804">setTriggerForce</a>(uint8_t start, uint8_t force) {</div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160; <span class="keywordflow">if</span> (force == 0)</div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160; data.effectType = EffectType::NoResitance;</div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160; <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; data.effectType = EffectType::ContinuousResitance;</div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160; data.Continuous.startPosition = start;</div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160; data.Continuous.force = force;</div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160; }</div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160; </div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160; <a class="code" href="class_p_s5_trigger.html#ae0267c7b60ebb176c54a42072647a866">reportChanged</a> = <span class="keyword">true</span>;</div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160; };</div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160; </div>
<div class="line"><a name="l00137"></a><span class="lineno"><a class="line" href="class_p_s5_trigger.html#aac9c57a1560f1b21cba5ec5dff1e7109"> 137</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_p_s5_trigger.html#aac9c57a1560f1b21cba5ec5dff1e7109">setTriggerForceSection</a>(uint8_t start, uint8_t end) {</div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160; data.effectType = EffectType::SectionResitance;</div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160; data.Section.startPosition = start;</div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160; data.Section.endPosition = end;</div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160; </div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160; <a class="code" href="class_p_s5_trigger.html#ae0267c7b60ebb176c54a42072647a866">reportChanged</a> = <span class="keyword">true</span>;</div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>&#160; };</div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>&#160; </div>
<div class="line"><a name="l00154"></a><span class="lineno"><a class="line" href="class_p_s5_trigger.html#aaf4dc1168b3a32da011813251dfa26da"> 154</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_p_s5_trigger.html#aaf4dc1168b3a32da011813251dfa26da">setTriggerForceEffect</a>(uint8_t start, <span class="keywordtype">bool</span> keep, uint8_t begin_force, uint8_t mid_force, uint8_t end_force, uint8_t frequency) {</div>
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span>&#160; data.effectType = EffectType::SectionResitance;</div>
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span>&#160; data.EffectEx.startPosition = start;</div>
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span>&#160; data.EffectEx.keepEffect = keep;</div>
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span>&#160; data.EffectEx.beginForce = begin_force;</div>
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span>&#160; data.EffectEx.middleForce = mid_force;</div>
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span>&#160; data.EffectEx.endForce = end_force;</div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span>&#160; data.EffectEx.frequency = frequency;</div>
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span>&#160; </div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span>&#160; <a class="code" href="class_p_s5_trigger.html#ae0267c7b60ebb176c54a42072647a866">reportChanged</a> = <span class="keyword">true</span>;</div>
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span>&#160; };</div>
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span>&#160; </div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span>&#160;};</div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span>&#160; </div>
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span>&#160;<span class="preprocessor">#endif</span></div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="aclass_p_s5_trigger_html_ad537a2d55a7d131e89e4257f015b741e"><div class="ttname"><a href="class_p_s5_trigger.html#ad537a2d55a7d131e89e4257f015b741e">PS5Trigger::Reset</a></div><div class="ttdeci">void Reset()</div><div class="ttdef"><b>Definition:</b> <a href="_p_s5_trigger_8h_source.html#l00100">PS5Trigger.h:100</a></div></div>
<div class="ttc" id="aclass_p_s5_trigger_html_aaf4dc1168b3a32da011813251dfa26da"><div class="ttname"><a href="class_p_s5_trigger.html#aaf4dc1168b3a32da011813251dfa26da">PS5Trigger::setTriggerForceEffect</a></div><div class="ttdeci">void setTriggerForceEffect(uint8_t start, bool keep, uint8_t begin_force, uint8_t mid_force, uint8_t end_force, uint8_t frequency)</div><div class="ttdef"><b>Definition:</b> <a href="_p_s5_trigger_8h_source.html#l00154">PS5Trigger.h:154</a></div></div>
<div class="ttc" id="aclass_p_s5_trigger_html_ae0267c7b60ebb176c54a42072647a866"><div class="ttname"><a href="class_p_s5_trigger.html#ae0267c7b60ebb176c54a42072647a866">PS5Trigger::reportChanged</a></div><div class="ttdeci">bool reportChanged</div><div class="ttdef"><b>Definition:</b> <a href="_p_s5_trigger_8h_source.html#l00088">PS5Trigger.h:88</a></div></div>
<div class="ttc" id="aclass_p_s5_trigger_html_aac9c57a1560f1b21cba5ec5dff1e7109"><div class="ttname"><a href="class_p_s5_trigger.html#aac9c57a1560f1b21cba5ec5dff1e7109">PS5Trigger::setTriggerForceSection</a></div><div class="ttdeci">void setTriggerForceSection(uint8_t start, uint8_t end)</div><div class="ttdef"><b>Definition:</b> <a href="_p_s5_trigger_8h_source.html#l00137">PS5Trigger.h:137</a></div></div>
<div class="ttc" id="aclass_p_s5_trigger_html"><div class="ttname"><a href="class_p_s5_trigger.html">PS5Trigger</a></div><div class="ttdef"><b>Definition:</b> <a href="_p_s5_trigger_8h_source.html#l00038">PS5Trigger.h:38</a></div></div>
<div class="ttc" id="aclass_p_s5_trigger_html_a2ba3108980ad8e51c687f8b46f25d804"><div class="ttname"><a href="class_p_s5_trigger.html#a2ba3108980ad8e51c687f8b46f25d804">PS5Trigger::setTriggerForce</a></div><div class="ttdeci">void setTriggerForce(uint8_t start, uint8_t force)</div><div class="ttdef"><b>Definition:</b> <a href="_p_s5_trigger_8h_source.html#l00120">PS5Trigger.h:120</a></div></div>
<div class="ttc" id="aclass_p_s5_trigger_html_a4d5e773112d91bdae5163fc23fef53d9"><div class="ttname"><a href="class_p_s5_trigger.html#a4d5e773112d91bdae5163fc23fef53d9">PS5Trigger::clearTriggerForce</a></div><div class="ttdeci">void clearTriggerForce()</div><div class="ttdef"><b>Definition:</b> <a href="_p_s5_trigger_8h_source.html#l00109">PS5Trigger.h:109</a></div></div>
<div class="ttc" id="aclass_p_s5_trigger_html_a5cf79bb95535c3c540ef698921989691"><div class="ttname"><a href="class_p_s5_trigger.html#a5cf79bb95535c3c540ef698921989691">PS5Trigger::processTrigger</a></div><div class="ttdeci">void processTrigger(uint8_t *buffer)</div><div class="ttdoc">Apply the trigger data to a PS5 update buffer.</div><div class="ttdef"><b>Definition:</b> <a href="_p_s5_trigger_8cpp_source.html#l00034">PS5Trigger.cpp:34</a></div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>