Prep for v1.0.0
[hackover2013-badge-firmware.git] / drivers / displays / tft / hw / template.c
1 /**************************************************************************/
2 /*!
3 @file
4 @author
5
6 @section DESCRIPTION
7
8 TODO
9
10 @section LICENSE
11
12 Software License Agreement (BSD License)
13
14 Copyright (c) 2010, microBuilder SARL
15 All rights reserved.
16
17 Redistribution and use in source and binary forms, with or without
18 modification, are permitted provided that the following conditions are met:
19 1. Redistributions of source code must retain the above copyright
20 notice, this list of conditions and the following disclaimer.
21 2. Redistributions in binary form must reproduce the above copyright
22 notice, this list of conditions and the following disclaimer in the
23 documentation and/or other materials provided with the distribution.
24 3. Neither the name of the copyright holders nor the
25 names of its contributors may be used to endorse or promote products
26 derived from this software without specific prior written permission.
27
28 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ''AS IS'' AND ANY
29 EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
30 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
31 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE FOR ANY
32 DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
33 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
34 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
35 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
36 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
37 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
38 */
39 /**************************************************************************/
40 #include "core/systick/systick.h"
41 #include "drivers/displays/tft/touchscreen.h"
42
43 // Screen width, height, has touchscreen, support orientation changes, support hw scrolling
44 static lcdProperties_t templateProperties = { 240, 320, false, false, false };
45
46 /*************************************************/
47 /* Private Methods */
48 /*************************************************/
49
50 // Todo: Functions to init the LCD, send commands, etc.
51
52 /*************************************************/
53 /* Public Methods */
54 /*************************************************/
55
56 // The following functions add need to be written to match the generic
57 // lcd interface defined by lcd.h
58
59 /**************************************************************************/
60 /*!
61 @brief Configures any pins or HW and initialises the LCD controller
62 */
63 /**************************************************************************/
64 void lcdInit(void)
65 {
66 }
67
68 /**************************************************************************/
69 /*!
70 @brief Enables or disables the LCD backlight
71 */
72 /**************************************************************************/
73 void lcdBacklight(bool state)
74 {
75 }
76
77 /**************************************************************************/
78 /*!
79 @brief Renders a simple test pattern on the LCD
80 */
81 /**************************************************************************/
82 void lcdTest(void)
83 {
84 }
85
86 /**************************************************************************/
87 /*!
88 @brief Fills the LCD with the specified 16-bit color
89 */
90 /**************************************************************************/
91 void lcdFillRGB(uint16_t data)
92 {
93 }
94
95 /**************************************************************************/
96 /*!
97 @brief Draws a single pixel at the specified X/Y location
98 */
99 /**************************************************************************/
100 void lcdDrawPixel(uint16_t x, uint16_t y, uint16_t color)
101 {
102 }
103
104 /**************************************************************************/
105 /*!
106 @brief Draws an array of consecutive RGB565 pixels (much
107 faster than addressing each pixel individually)
108 */
109 /**************************************************************************/
110 void lcdDrawPixels(uint16_t x, uint16_t y, uint16_t *data, uint32_t len)
111 {
112 }
113
114 /**************************************************************************/
115 /*!
116 @brief Optimised routine to draw a horizontal line faster than
117 setting individual pixels
118 */
119 /**************************************************************************/
120 void lcdDrawHLine(uint16_t x0, uint16_t x1, uint16_t y, uint16_t color)
121 {
122 }
123
124 /**************************************************************************/
125 /*!
126 @brief Optimised routine to draw a vertical line faster than
127 setting individual pixels
128 */
129 /**************************************************************************/
130 void lcdDrawVLine(uint16_t x, uint16_t y0, uint16_t y1, uint16_t color)
131 {
132 }
133
134 /**************************************************************************/
135 /*!
136 @brief Gets the 16-bit color of the pixel at the specified location
137 */
138 /**************************************************************************/
139 uint16_t lcdGetPixel(uint16_t x, uint16_t y)
140 {
141 }
142
143 /**************************************************************************/
144 /*!
145 @brief Sets the LCD orientation to horizontal and vertical
146 */
147 /**************************************************************************/
148 void lcdSetOrientation(lcdOrientation_t orientation)
149 {
150 }
151
152 /**************************************************************************/
153 /*!
154 @brief Gets the current screen orientation (horizontal or vertical)
155 */
156 /**************************************************************************/
157 lcdOrientation_t lcdGetOrientation(void)
158 {
159 }
160
161 /**************************************************************************/
162 /*!
163 @brief Gets the width in pixels of the LCD screen (varies depending
164 on the current screen orientation)
165 */
166 /**************************************************************************/
167 uint16_t lcdGetWidth(void)
168 {
169 }
170
171 /**************************************************************************/
172 /*!
173 @brief Gets the height in pixels of the LCD screen (varies depending
174 on the current screen orientation)
175 */
176 /**************************************************************************/
177 uint16_t lcdGetHeight(void)
178 {
179 }
180
181 /**************************************************************************/
182 /*!
183 @brief Scrolls the contents of the LCD screen vertically the
184 specified number of pixels using a HW optimised routine
185 */
186 /**************************************************************************/
187 void lcdScroll(int16_t pixels, uint16_t fillColor)
188 {
189 }
190
191 /**************************************************************************/
192 /*!
193 @brief Gets the controller's 16-bit (4 hexdigit) ID
194 */
195 /**************************************************************************/
196 uint16_t lcdGetControllerID(void)
197 {
198 }
199
200 /**************************************************************************/
201 /*!
202 @brief Returns the LCDs 'lcdProperties_t' that describes the LCDs
203 generic capabilities and dimensions
204 */
205 /**************************************************************************/
206 lcdProperties_t lcdGetProperties(void)
207 {
208 }
This page took 0.064312 seconds and 5 git commands to generate.