MPLAB® Harmony Graphics Suite  GFX v3.13.0
Legato API Documentation
plib_glcd.h
Go to the documentation of this file.
1 // DOM-IGNORE-BEGIN
2 /*******************************************************************************
3 * Copyright (C) 2020 Microchip Technology Inc. and its subsidiaries.
4 *
5 * Subject to your compliance with these terms, you may use Microchip software
6 * and any derivatives exclusively with Microchip products. It is your
7 * responsibility to comply with third party license terms applicable to your
8 * use of third party software (including open source software) that may
9 * accompany Microchip software.
10 *
11 * THIS SOFTWARE IS SUPPLIED BY MICROCHIP "AS IS". NO WARRANTIES, WHETHER
12 * EXPRESS, IMPLIED OR STATUTORY, APPLY TO THIS SOFTWARE, INCLUDING ANY IMPLIED
13 * WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY, AND FITNESS FOR A
14 * PARTICULAR PURPOSE.
15 *
16 * IN NO EVENT WILL MICROCHIP BE LIABLE FOR ANY INDIRECT, SPECIAL, PUNITIVE,
17 * INCIDENTAL OR CONSEQUENTIAL LOSS, DAMAGE, COST OR EXPENSE OF ANY KIND
18 * WHATSOEVER RELATED TO THE SOFTWARE, HOWEVER CAUSED, EVEN IF MICROCHIP HAS
19 * BEEN ADVISED OF THE POSSIBILITY OR THE DAMAGES ARE FORESEEABLE. TO THE
20 * FULLEST EXTENT ALLOWED BY LAW, MICROCHIP'S TOTAL LIABILITY ON ALL CLAIMS IN
21 * ANY WAY RELATED TO THIS SOFTWARE WILL NOT EXCEED THE AMOUNT OF FEES, IF ANY,
22 * THAT YOU HAVE PAID DIRECTLY TO MICROCHIP FOR THIS SOFTWARE.
23 *******************************************************************************/
24 // DOM-IGNORE-END
25 
26 /********************************************************************************
27  GLCD Peripheral Library
28 
29  Company:
30  Microchip Technology Inc.
31 
32  File Name:
33  plib_glcd.c
34 
35  Summary:
36  GLCD function implementations for the GLCD PLIB.
37 
38  Description:
39  The GLCD PLIB provides a simple interface to manage the GLCD controller.
40 *******************************************************************************/
41 
48 #ifndef PLIB_GLCD_H
49 #define PLIB_GLCD_H
50 
51 // DOM-IGNORE-BEGIN
52 #ifdef __cplusplus // Provide C++ Compatibility
53 
54  extern "C" {
55 
56 #endif
57 // DOM-IGNORE-END
58 
59 typedef enum {
60 
61  GLCD_ID_0 = 0,
62  GLCD_NUMBER_OF_MODULES = 1
63 
64 } GLCD_MODULE_ID;
65 
66 typedef enum {
67 
68  GLCD_RGB_MODE_PARALLEL_RGB565 = 0x00000000,
69  GLCD_RGB_MODE_PARALLEL_RGB888 = 0x00000001,
70  GLCD_RGB_MODE_SERIAL_RGB_3 = 0x00000002,
71  GLCD_RGB_MODE_SERIAL_RGBA_4 = 0x00000003,
72  GLCD_RGB_MODE_SERIAL_12BIT = 0x00000004,
73  GLCD_RGB_MODE_YUYV_16BIT = 0x00000005,
74  GLCD_RGB_MODE_BT_656 = 0x00000006
75 
76 } GLCD_RGB_MODE;
77 
78 typedef enum {
79 
80  GLCD_POLARITY_POSITIVE = 0x00000000,
81  GLCD_PIXEL_CLOCK_POLARITY_NEGATIVE = 0x00400000,
82  GLCD_DE_POLARITY_NEGATIVE = 0x04000000,
83  GLCD_HSYNC_POLARITY_NEGATIVE = 0x08000000,
84  GLCD_VSYNC_POLARITY_NEGATIVE = 0x10000000
85 
86 } GLCD_SIGNAL_POLARITY;
87 
88 typedef enum {
89 
90  GLCD_LAYER_ID_0 = 0x0,
91  GLCD_LAYER_ID_1 = 0x1,
92  GLCD_LAYER_ID_2 = 0x2,
93  GLCD_LAYER_ID_MAX = 0x3
94 
95 } GLCD_LAYER_ID;
96 
97 typedef enum {
98 
99  GLCD_LAYER_COLOR_MODE_LUT8 = 0x0,
100  GLCD_LAYER_COLOR_MODE_RGBA5551 = 0x1,
101  GLCD_LAYER_COLOR_MODE_RGBA8888 = 0x2,
102  GLCD_LAYER_COLOR_MODE_RGB332 = 0x4,
103  GLCD_LAYER_COLOR_MODE_RGB565 = 0x5,
104  GLCD_LAYER_COLOR_MODE_ARGB8888 = 0x6,
105  GLCD_LAYER_COLOR_MODE_L8 = 0x7,
106  GLCD_LAYER_COLOR_MODE_L1 = 0x8,
107  GLCD_LAYER_COLOR_MODE_L4 = 0x9,
108  GLCD_LAYER_COLOR_MODE_YUYV = 0xA,
109  GLCD_LAYER_COLOR_MODE_RGB888 = 0xB
110 
111 } GLCD_LAYER_COLOR_MODE;
112 
113 typedef enum {
114 
115  GLCD_LAYER_SRC_BLEND_BLACK = 0x0000,
116  GLCD_LAYER_SRC_BLEND_WHITE = 0x0100,
117  GLCD_LAYER_SRC_BLEND_ALPHA_SRC = 0x0200,
118  GLCD_LAYER_SRC_BLEND_ALPHA_GBL = 0x0300,
119  GLCD_LAYER_SRC_BLEND_ALPHA_SRCGBL = 0x0400,
120  GLCD_LAYER_SRC_BLEND_INV_SRC = 0x0500,
121  GLCD_LAYER_SRC_BLEND_INV_GBL = 0x0600,
122  GLCD_LAYER_SRC_BLEND_INV_SRCGBL = 0x0700,
123  GLCD_LAYER_SRC_BLEND_ALPHA_DST = 0x0A00,
124  GLCD_LAYER_SRC_BLEND_INV_DST = 0x0D00
125 
126 } GLCD_LAYER_SRC_BLEND_FUNC;
127 
128 typedef enum {
129 
130  GLCD_LAYER_DEST_BLEND_BLACK = 0x0000,
131  GLCD_LAYER_DEST_BLEND_WHITE = 0x1000,
132  GLCD_LAYER_DEST_BLEND_ALPHA_SRC = 0x2000,
133  GLCD_LAYER_DEST_BLEND_ALPHA_GBL = 0x3000,
134  GLCD_LAYER_DEST_BLEND_ALPHA_SRCGBL = 0x4000,
135  GLCD_LAYER_DEST_BLEND_INV_SRC = 0x5000,
136  GLCD_LAYER_DEST_BLEND_INV_GBL = 0x6000,
137  GLCD_LAYER_DEST_BLEND_INV_SRCGBL = 0x7000,
138  GLCD_LAYER_DEST_BLEND_ALPHA_DST = 0xA000,
139  GLCD_LAYER_DEST_BLEND_INV_DST = 0xD000
140 
141 } GLCD_LAYER_DEST_BLEND_FUNC;
142 
143 typedef enum {
144 
145  GLCD_IRQ_TRIGGER_LEVEL = 0x00000000,
146  GLCD_IRQ_TRIGGER_EDGE = 0x80000000
147 
148 } GLCD_IRQ_TRIGGER_CONTROL;
149 
150 //******************************************************************************
151 /* Function : PLIB_GLCD_LayerColorModeSet
152 
153  Summary:
154  Sets the layer color mode
155 
156  Description:
157 
158 */
159 void PLIB_GLCD_LayerColorModeSet(GLCD_LAYER_ID layerId, GLCD_LAYER_COLOR_MODE colorMode);
160 
161 //******************************************************************************
162 /* Function : PLIB_GLCD_LayerStrideSet
163 
164  Summary:
165  Sets the layer stride
166 
167  Description:
168 
169 */
170 void PLIB_GLCD_LayerStrideSet(GLCD_LAYER_ID layerId, uint32_t stride);
171 
172 //******************************************************************************
173 /* Function : PLIB_GLCD_LayerBaseAddressSet
174 
175  Summary:
176  Sets the layer base address
177 
178  Description:
179 
180 */
181 void PLIB_GLCD_LayerBaseAddressSet(GLCD_LAYER_ID layerId, uint32_t baseAddress);
182 
183 //******************************************************************************
184 /* Function : PLIB_GLCD_LayerStartXYSet
185 
186  Summary:
187  Sets the layer V and H offset
188 
189  Description:
190 
191 */
192 void PLIB_GLCD_LayerStartXYSet(GLCD_LAYER_ID layerId, uint32_t startX, uint32_t startY);
193 
194 //******************************************************************************
195 /* Function : PLIB_GLCD_LayerSizeXYSet
196 
197  Summary:
198  Sets the layer X, Y size
199 
200  Description:
201 
202 */
203 void PLIB_GLCD_LayerSizeXYSet(GLCD_LAYER_ID layerId, uint32_t sizeX, uint32_t sizeY);
204 
205 //******************************************************************************
206 /* Function : PLIB_GLCD_LayerGlobalAlphaSet
207 
208  Summary:
209  Sets the layer alpha
210 
211  Description:
212 
213 */
214 void PLIB_GLCD_LayerGlobalAlphaSet(GLCD_LAYER_ID layerId, uint8_t value);
215 
216 //******************************************************************************
217 /* Function : PLIB_GLCD_LayerGlobalAlphaGet
218 
219  Summary:
220  Returns the layer's global alpha
221 
222  Description:
223 
224 */
225 uint8_t PLIB_GLCD_LayerGlobalAlphaGet(GLCD_LAYER_ID layerId);
226 
227 //******************************************************************************
228 /* Function : PLIB_GLCD_LayerEnable
229 
230  Summary:
231  Enables the specified layer
232 
233  Description:
234 
235 */
236 void PLIB_GLCD_LayerEnable(GLCD_LAYER_ID layerId);
237 
238 //******************************************************************************
239 /* Function : PLIB_GLCD_LayerDisable
240 
241  Summary:
242  Disables the specified layer
243 
244  Description:
245 
246 */
247 void PLIB_GLCD_LayerDisable(GLCD_LAYER_ID layerId);
248 
249 //******************************************************************************
250 /* Function : PLIB_GLCD_Enable
251 
252  Summary:
253  Enables the GLCD peripheral
254 
255  Description:
256 
257 */
258 void PLIB_GLCD_Enable(void);
259 
260 //******************************************************************************
261 /* Function : PLIB_GLCD_Disable
262 
263  Summary:
264  Disables the GLCD peripheral
265 
266  Description:
267 
268 */
269 void PLIB_GLCD_Disable(void);
270 
271 //******************************************************************************
272 /* Function : PLIB_GLCD_BackgroundColorSet
273 
274  Summary:
275  Sets the background layer color
276 
277  Description:
278 
279 */
280 void PLIB_GLCD_BackgroundColorSet(uint32_t bgColor);
281 
282 //******************************************************************************
283 /* Function : PLIB_GLCD_HSyncInterruptDisable
284 
285  Summary:
286  Enables the GLCD HSYNC Interrupt
287 
288  Description:
289 
290 */
291 void PLIB_GLCD_HSyncInterruptDisable(void);
292 
293 //******************************************************************************
294 /* Function : PLIB_GLCD_RGBSequentialModeSet
295 
296  Summary:
297  Sets the GLCD sequential mode
298 
299  Description:
300 
301 */
302 void PLIB_GLCD_RGBSequentialModeSet(GLCD_RGB_MODE mode);
303 
304 //******************************************************************************
305 /* Function : PLIB_GLCD_FrontPorchXYSet
306 
307  Summary:
308  Sets the V and H Front porch
309 
310  Description:
311 
312 */
313 void PLIB_GLCD_FrontPorchXYSet(uint32_t frontPorchX, uint32_t frontPorchY);
314 
315 //******************************************************************************
316 /* Function : PLIB_GLCD_BlankingXYSet
317 
318  Summary:
319  Sets the V and H blanking period
320 
321  Description:
322 
323 */
324 void PLIB_GLCD_BlankingXYSet(uint32_t blankingX, uint32_t blankingY);
325 
326 //******************************************************************************
327 /* Function : PLIB_GLCD_BackPorchXYSet
328 
329  Summary:
330  Sets the V and H back porch
331 
332  Description:
333 
334 */
335 void PLIB_GLCD_BackPorchXYSet(uint32_t backPorchX, uint32_t backPorchY);
336 
337 //******************************************************************************
338 /* Function : PLIB_GLCD_ClockDividerSet
339 
340  Summary:
341  Sets the GLCD clock divider for pixel clock
342 
343  Description:
344 
345 */
346 void PLIB_GLCD_ClockDividerSet(uint32_t clockDivider);
347 
348 //******************************************************************************
349 /* Function : PLIB_GLCD_ResolutionXYSet
350 
351  Summary:
352  Sets the V and H resolution
353 
354  Description:
355 
356 */
357 void PLIB_GLCD_ResolutionXYSet(uint32_t resolutionX, uint32_t resolutionY);
358 
359 //******************************************************************************
360 /* Function : PLIB_GLCD_SignalPolaritySet
361 
362  Summary:
363  Sets the polarity of the GLCD control signals
364 
365  Description:
366 
367 */
368 void PLIB_GLCD_SignalPolaritySet(GLCD_SIGNAL_POLARITY polarity);
369 
370 //******************************************************************************
371 /* Function : PLIB_GLCD_LayerResXYSet
372 
373  Summary:
374  Sets the layer V and H resolution
375 
376  Description:
377 
378 */
379 void PLIB_GLCD_LayerResXYSet(GLCD_LAYER_ID layerId, uint32_t resolutionX, uint32_t resolutionY);
380 
381 //******************************************************************************
382 /* Function : PLIB_GLCD_LayerDestBlendFuncSet
383 
384  Summary:
385  Sets the layer destination blend function
386 
387  Description:
388 
389 */
390 void PLIB_GLCD_LayerDestBlendFuncSet(GLCD_LAYER_ID layerId, GLCD_LAYER_DEST_BLEND_FUNC blendFunc);
391 
392 //******************************************************************************
393 /* Function : PLIB_GLCD_LayerSrcBlendFuncSet
394 
395  Summary:
396  Sets the layer source blend function
397 
398  Description:
399 
400 */
401 void PLIB_GLCD_LayerSrcBlendFuncSet(GLCD_LAYER_ID layerId, GLCD_LAYER_SRC_BLEND_FUNC blendFunc);
402 
403 //******************************************************************************
404 /* Function : PLIB_GLCD_VSyncInterruptEnable
405 
406  Summary:
407  Enables the GLCD VSYNC interrupt
408 
409  Description:
410 
411 */
412 void PLIB_GLCD_VSyncInterruptEnable(void);
413 
414 //******************************************************************************
415 /* Function : PLIB_GLCD_VSyncInterruptDisable
416 
417  Summary:
418  Disables the GLCD VSYNC Interrupt
419 
420  Description:
421 
422 */
423 void PLIB_GLCD_VSyncInterruptDisable(void);
424 
425 //******************************************************************************
426 /* Function : PLIB_GLCD_IsVerticalBlankingActive
427 
428  Summary:
429  Returns 1 if GLCD is in VBLANK period
430 
431  Description:
432 
433 */
434 bool PLIB_GLCD_IsVerticalBlankingActive(void);
435 
436 //******************************************************************************
437 /* Function : PLIB_GLCD_GlobalColorLUTSet
438 
439  Summary:
440  Sets the global color LUT table
441 
442  Description:
443 
444 */
445 void PLIB_GLCD_GlobalColorLUTSet(uint32_t* globalLUT);
446 
447 //******************************************************************************
448 /* Function : PLIB_GLCD_PaletteGammaRampEnable
449 
450  Summary:
451  Enables the Palette Gamma Ramp
452 
453  Description:
454 
455 */
456 void PLIB_GLCD_PaletteGammaRampEnable(void);
457 
458 //******************************************************************************
459 /* Function : PLIB_GLCD_PaletteGammaRampDisable
460 
461  Summary:
462  Disables the Palette Gamma Ramp
463 
464  Description:
465 
466 */
467 void PLIB_GLCD_PaletteGammaRampDisable(void);
468 
469 // DOM-IGNORE-BEGIN
470 #ifdef __cplusplus // Provide C++ Compatibility
471 
472  }
473 
474 #endif
475 // DOM-IGNORE-END
476 #endif // PLIB_GLCD_H
477 
478