161 lines
17 KiB
HTML
161 lines
17 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.20"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>ESP32-WROVER-KIT-LCD-DRIVER: components/lcd/include/Driver.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="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">ESP32-WROVER-KIT-LCD-DRIVER
|
|
</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&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&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&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(function(){initNavTree('_driver_8h_source.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">Driver.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="_driver_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>  </div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#ifndef __DRIVER_H</span></div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#define __DRIVER_H</span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>  </div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#include <stdio.h></span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include <stdlib.h></span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include <string.h></span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#include "driver/spi_master.h"</span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#include "esp_system.h"</span></div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#include "driver/gpio.h"</span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#include "freertos/FreeRTOS.h"</span></div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#include "freertos/task.h"</span></div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  </div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="_driver_8h.html#ab92e6ca5a63084dc89b10b01c1f43a36"> 21</a></span> <span class="preprocessor">#define LCD_HOST HSPI_HOST</span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"><a class="line" href="_driver_8h.html#a5c8e512df4a72e57db32aca9123c172f"> 22</a></span> <span class="preprocessor">#define DMA_CHAN 2</span></div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  </div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="_driver_8h.html#a4ffa0949bfda52d9c7b37fcb148cbb53"> 24</a></span> <span class="preprocessor">#define PIN_NUM_MISO 25</span></div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="_driver_8h.html#a060569807a8819489e6a7b4ee17ad67b"> 25</a></span> <span class="preprocessor">#define PIN_NUM_MOSI 23</span></div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="_driver_8h.html#a756bcaa6e44d1879623a058849c66fbb"> 26</a></span> <span class="preprocessor">#define PIN_NUM_CLK 19</span></div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="_driver_8h.html#a6c332c3f862c9e17cb09b32c73516a4a"> 27</a></span> <span class="preprocessor">#define PIN_NUM_CS 22</span></div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  </div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="_driver_8h.html#a3d815411a5730aaa16b29eba886c2f89"> 29</a></span> <span class="preprocessor">#define PIN_NUM_DC 21</span></div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="_driver_8h.html#ae182645b129195913db278d6fcec38ae"> 30</a></span> <span class="preprocessor">#define PIN_NUM_RST 18</span></div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="_driver_8h.html#ac01f4eafb1a3eff33d14e7595115d9b2"> 31</a></span> <span class="preprocessor">#define PIN_NUM_BCKL 5</span></div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  </div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="_driver_8h.html#a19693eac3018d3e7800fde141921b812"> 33</a></span> <span class="preprocessor">#define LCD_WIDTH 320</span></div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="_driver_8h.html#a2f29bf2b8ebbade29cf04ca42de44c27"> 34</a></span> <span class="preprocessor">#define LCD_HIGH 240</span></div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  </div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment">//To speed up transfers, every SPI transfer sends a bunch of lines. This define specifies how many. More means more memory use,</span></div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment">//but less overhead for setting up / finishing transfers. Make sure 240 is dividable by this.</span></div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="_driver_8h.html#a5d25ddc479bad8adec832512e5b4eece"> 38</a></span> <span class="preprocessor">#define PARALLEL_LINES 16</span></div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  </div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> The LCD needs a bunch of command/argument values to be initialized. They are stored in this struct.</span></div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="structlcd__init__cmd__t.html"> 43</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="structlcd__init__cmd__t.html#a4d43e8212bdc9dbee866506f04effcea"> 44</a></span>  uint8_t <a class="code" href="structlcd__init__cmd__t.html#a4d43e8212bdc9dbee866506f04effcea">cmd</a>;</div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="structlcd__init__cmd__t.html#a2ddb79fb93f7d950e5cc9059ad5f7e02"> 45</a></span>  uint8_t data[16];</div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="structlcd__init__cmd__t.html#aee6f3ae53f83fcbcdbd04b5053606a97"> 46</a></span>  uint8_t <a class="code" href="structlcd__init__cmd__t.html#aee6f3ae53f83fcbcdbd04b5053606a97">databytes</a>; <span class="comment">//No of data in data; bit 7 = delay after set; 0xFF = end of cmds.</span></div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> } <a class="code" href="structlcd__init__cmd__t.html">lcd_init_cmd_t</a>;</div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  </div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="_driver_8h.html#af7d58f245cddf61cb03041b87649be87"> 49</a></span> <span class="keyword">typedef</span> <span class="keyword">enum</span> {</div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="_driver_8h.html#af7d58f245cddf61cb03041b87649be87a43969af9123789fbe2dc107d2ba52414"> 50</a></span>  <a class="code" href="_driver_8h.html#af7d58f245cddf61cb03041b87649be87a43969af9123789fbe2dc107d2ba52414">LCD_TYPE_ILI</a> = 1,</div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="_driver_8h.html#af7d58f245cddf61cb03041b87649be87a81e4b8462aa2094b20d9951ca192e771"> 51</a></span>  <a class="code" href="_driver_8h.html#af7d58f245cddf61cb03041b87649be87a81e4b8462aa2094b20d9951ca192e771">LCD_TYPE_ST</a>,</div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="_driver_8h.html#af7d58f245cddf61cb03041b87649be87a25e54d1c5bfe717fa20bc4773be47639"> 52</a></span>  <a class="code" href="_driver_8h.html#af7d58f245cddf61cb03041b87649be87a25e54d1c5bfe717fa20bc4773be47639">LCD_TYPE_MAX</a>,</div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> } <a class="code" href="_driver_8h.html#af7d58f245cddf61cb03041b87649be87">type_lcd_t</a>;</div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  </div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> esp_err_t <a class="code" href="_driver_8h.html#adb1369972e80eb05d5e831cbc7cf3d4f">vDriver_init</a>(<span class="keywordtype">void</span>);</div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> esp_err_t <a class="code" href="_driver_8h.html#a62a79453d5cfaf0693a21714162f22d4">iDriver_writeFramebuffer</a>(uint16_t ***<a class="code" href="_l_c_d_8c.html#a1cf4497f1e3b602bc54e6f42ea73d9ed">pu16Framebuffer</a>);</div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  </div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="preprocessor">#endif </span><span class="comment">/* __DRIVER_H */</span><span class="preprocessor"></span></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<div class="ttc" id="a_driver_8h_html_af7d58f245cddf61cb03041b87649be87a81e4b8462aa2094b20d9951ca192e771"><div class="ttname"><a href="_driver_8h.html#af7d58f245cddf61cb03041b87649be87a81e4b8462aa2094b20d9951ca192e771">LCD_TYPE_ST</a></div><div class="ttdeci">@ LCD_TYPE_ST</div><div class="ttdef"><b>Definition:</b> Driver.h:51</div></div>
|
|
<div class="ttc" id="a_driver_8h_html_af7d58f245cddf61cb03041b87649be87a25e54d1c5bfe717fa20bc4773be47639"><div class="ttname"><a href="_driver_8h.html#af7d58f245cddf61cb03041b87649be87a25e54d1c5bfe717fa20bc4773be47639">LCD_TYPE_MAX</a></div><div class="ttdeci">@ LCD_TYPE_MAX</div><div class="ttdef"><b>Definition:</b> Driver.h:52</div></div>
|
|
<div class="ttc" id="a_driver_8h_html_a62a79453d5cfaf0693a21714162f22d4"><div class="ttname"><a href="_driver_8h.html#a62a79453d5cfaf0693a21714162f22d4">iDriver_writeFramebuffer</a></div><div class="ttdeci">esp_err_t iDriver_writeFramebuffer(uint16_t ***pu16Framebuffer)</div><div class="ttdoc">write framebuffer to LCD via SPI</div><div class="ttdef"><b>Definition:</b> Driver.c:341</div></div>
|
|
<div class="ttc" id="a_c_make_lists_8txt_html_ac91c459607464754efeb41fb7847c9fc"><div class="ttname"><a href="_c_make_lists_8txt.html#ac91c459607464754efeb41fb7847c9fc">set</a></div><div class="ttdeci">set(srcs "src/LCD.c" "src/Driver.c") idf_component_register(SRCS "$</div><div class="ttdef"><b>Definition:</b> CMakeLists.txt:1</div></div>
|
|
<div class="ttc" id="a_driver_8h_html_af7d58f245cddf61cb03041b87649be87a43969af9123789fbe2dc107d2ba52414"><div class="ttname"><a href="_driver_8h.html#af7d58f245cddf61cb03041b87649be87a43969af9123789fbe2dc107d2ba52414">LCD_TYPE_ILI</a></div><div class="ttdeci">@ LCD_TYPE_ILI</div><div class="ttdef"><b>Definition:</b> Driver.h:50</div></div>
|
|
<div class="ttc" id="a_driver_8h_html_adb1369972e80eb05d5e831cbc7cf3d4f"><div class="ttname"><a href="_driver_8h.html#adb1369972e80eb05d5e831cbc7cf3d4f">vDriver_init</a></div><div class="ttdeci">esp_err_t vDriver_init(void)</div><div class="ttdoc">Initialize the driver.</div><div class="ttdef"><b>Definition:</b> Driver.c:130</div></div>
|
|
<div class="ttc" id="a_driver_8h_html_af7d58f245cddf61cb03041b87649be87"><div class="ttname"><a href="_driver_8h.html#af7d58f245cddf61cb03041b87649be87">type_lcd_t</a></div><div class="ttdeci">type_lcd_t</div><div class="ttdef"><b>Definition:</b> Driver.h:49</div></div>
|
|
<div class="ttc" id="a_l_c_d_8c_html_a1cf4497f1e3b602bc54e6f42ea73d9ed"><div class="ttname"><a href="_l_c_d_8c.html#a1cf4497f1e3b602bc54e6f42ea73d9ed">pu16Framebuffer</a></div><div class="ttdeci">uint16_t ** pu16Framebuffer</div><div class="ttdef"><b>Definition:</b> LCD.c:23</div></div>
|
|
<div class="ttc" id="astructlcd__init__cmd__t_html_aee6f3ae53f83fcbcdbd04b5053606a97"><div class="ttname"><a href="structlcd__init__cmd__t.html#aee6f3ae53f83fcbcdbd04b5053606a97">lcd_init_cmd_t::databytes</a></div><div class="ttdeci">uint8_t databytes</div><div class="ttdef"><b>Definition:</b> Driver.h:46</div></div>
|
|
<div class="ttc" id="astructlcd__init__cmd__t_html_a4d43e8212bdc9dbee866506f04effcea"><div class="ttname"><a href="structlcd__init__cmd__t.html#a4d43e8212bdc9dbee866506f04effcea">lcd_init_cmd_t::cmd</a></div><div class="ttdeci">uint8_t cmd</div><div class="ttdef"><b>Definition:</b> Driver.h:44</div></div>
|
|
<div class="ttc" id="astructlcd__init__cmd__t_html"><div class="ttname"><a href="structlcd__init__cmd__t.html">lcd_init_cmd_t</a></div><div class="ttdef"><b>Definition:</b> Driver.h:43</div></div>
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_409f97388efe006bc3438b95e9edef48.html">components</a></li><li class="navelem"><a class="el" href="dir_8c3047c3b01c62334c9cb3295fc1c68f.html">lcd</a></li><li class="navelem"><a class="el" href="dir_fa7a4d24b569216cf1b68f7e93657ef0.html">include</a></li><li class="navelem"><a class="el" href="_driver_8h.html">Driver.h</a></li>
|
|
<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>
|