[processor-sdk/performance-audio-sr.git] / psdk_cust / pdk_k2g_1_0_1_2_eng / packages / ti / board / diag / lcd / src / evmk2g_dss_panel.h
1 /*
2 * Copyright (c) 2016, Texas Instruments Incorporated
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * * Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 *
12 * * Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 *
16 * * Neither the name of Texas Instruments Incorporated nor the names of
17 * its contributors may be used to endorse or promote products derived
18 * from this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
22 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
24 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
27 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
28 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
29 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
30 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 *
32 */
34 /**
35 *
36 * \file evmk2g_dss_panel.h
37 *
38 * \brief This file contains LCD panel specific structure, typedefs,
39 * function prototypes.
40 *
41 ******************************************************************************/
43 #ifndef _EVMK2G_DSS_PANEL_H_
44 #define _EVMK2G_DSS_PANEL_H_
46 /**
47 * \brief This function initializes LCD Panel module.
48 *
49 * This function should be called before using any other DSS functions.
50 * This function configures the LCD parameters and then configures DSS.
51 *
52 * \param
53 * pLcdCfg - pointer to LCD configuration
54 *
55 * \return
56 * DSS_RET_OK - If successful
57 * DSS_RET_FAILED - If failure
58 *
59 */
60 DSS_RET lcdPanelInit(lcdCfg_t *pLcdCfg);
62 /**
63 * \brief Display color bar on the LCD
64 *
65 * This function calls the function to put the color bar information on the
66 * framebuffer and hence displays the Color bar on the LCD screen
67 *
68 * \param
69 * pLcdCfg - pointer to LCD configuration
70 *
71 * \return
72 * None
73 *
74 */
75 void lcdColorBarDisplay(lcdCfg_t *pLcdCfg);
77 #ifdef DISPLAY_LOGO
78 void lcdLogoDisplay(void);
79 #endif
80 /**
81 * \brief Display a single color on the LCD screen
82 *
83 * This function calls the function to put a single color passed as an argument
84 * on the framebuffer and hence displays the Color screen on the LCD screen
85 *
86 * \param
87 * pLcdCfg - pointer to LCD configuration
88 * color - Color to be displayed on the screen.
89 *
90 * \return
91 * None
92 *
93 */
94 void lcdColorDisplay(lcdCfg_t *pLcdCfg, int color);
96 #endif // _EVMK2G_DSS_PANEL_H_
98 /* Nothing past this point */