/* ChibiOS/RT - Copyright (C) 2006,2007,2008,2009,2010, 2011,2012 Giovanni Di Sirio. This file is part of ChibiOS/RT. ChibiOS/RT is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. ChibiOS/RT is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see . --- A special exception to the GPL can be applied should you wish to distribute a combined work that includes ChibiOS/RT, without being obliged to provide the source code for any proprietary components. See the file exception.txt for full details of how and when the exception can be applied. */ /* Concepts and parts of this file have been contributed by: Joel Bodenmann aka Tectu -> Maintainer Andrew Hannam aka inmarket -> framework Badger -> console implementation and FSMC Abhishek -> font rendering Ben William -> fastMath and lcdDrawEllipse() Dongxu Li aka dxli -> lcdDrawEllipse() filled option */ /** * @file templates/gdisp_lld.c * @brief GDISP Graphics Driver subsystem low level driver source template. * * @addtogroup GDISP * @{ */ #include "ch.h" #include "hal.h" #include "gdisp.h" #if HAL_USE_GDISP || defined(__DOXYGEN__) /*===========================================================================*/ /* Driver local definitions. */ /*===========================================================================*/ #ifdef UNUSED #elif defined(__GNUC__) # define UNUSED(x) UNUSED_ ## x __attribute__((unused)) #elif defined(__LCLINT__) # define UNUSED(x) /*@unused@*/ x #else # define UNUSED(x) x #endif /*===========================================================================*/ /* Driver exported variables. */ /*===========================================================================*/ #if !defined(__DOXYGEN__) GDISPDriver GDISP1; #endif /*===========================================================================*/ /* Driver local variables. */ /*===========================================================================*/ /*===========================================================================*/ /* Driver local functions. */ /*===========================================================================*/ /*===========================================================================*/ /* Driver interrupt handlers. */ /*===========================================================================*/ /*===========================================================================*/ /* Driver exported functions. */ /*===========================================================================*/ /* ---- Required Routines ---- */ /* The following 2 routines are required. All other routines are optional. */ /** * @brief Low level GDISP driver initialization. * * @notapi */ void gdisp_lld_init(void) { /* Initialise the GDISP structure with the defaults for your display */ GDISP1.Width = 128; GDISP1.Height = 128; GDISP1.Orientation = portrait; GDISP1.Powermode = powerOff; /* Now initialise your display to match */ /* Code here */ } /** * @brief Draws a pixel on the display. * * @param[in] x X location of the pixel * @param[in] y Y location of the pixel * @param[in] color The color of the pixel * * @notapi */ void gdisp_lld_drawpixel(coord_t x, coord_t y, color_t color) { #if GDISP_NEED_VALIDATION if (x >= GDISP1.Width || y >= GDISP1.Height) return; #endif /* Code here */ } /* ---- Optional Routines ---- */ /* All the below routines are optional. Defining them will increase speed but everything will work if they are not defined. If you are not using a routine - turn it off using the appropriate GDISP_HARDWARE_XXXX macro. Don't bother coding for obvious similar routines if there is no performance penalty as the emulation software makes a good job of using similar routines. eg. If gdisp_lld_fillarea() is defined there is little point in defining gdisp_lld_clear() unless the performance bonus is significant. For good performance it is suggested to implement gdisp_lld_fillarea() and gdisp_lld_blitarea(). */ #if GDISP_HARDWARE_POWERCONTROL || defined(__DOXYGEN__) /** * @brief Sets the power mode for the graphic device. * @note The power modes are powerOn, powerSleep and powerOff. * If powerSleep is not supported it is equivelent to powerOn. * * @param[in] powerMode The new power mode * * @notapi */ void gdisp_lld_setpowermode(gdisp_powermode_t powerMode) { /* Code here */ /* if successful GDISP1.Powermode = powerMode; */ } #endif #if GDISP_HARDWARE_ORIENTATION || defined(__DOXYGEN__) /** * @brief Sets the orientation of the display. * @note This may be ignored if not supported by the device. * * @param[in] newOrientation The new orientation * * @notapi */ void gdisp_lld_setorientation(gdisp_orientation_t newOrientation) { /* Code here */ /* if successful GDISP1.Orientation = newOrientation; */ } #endif #if GDISP_HARDWARE_CLEARS || defined(__DOXYGEN__) /** * @brief Clear the display. * @note Optional - The high level driver can emulate using software. * * @param[in] color The color of the pixel * * @notapi */ void gdisp_lld_clear(color_t color) { /* Code here */ } #endif #if GDISP_HARDWARE_LINES || defined(__DOXYGEN__) /** * @brief Draw a line. * @note Optional - The high level driver can emulate using software. * * @param[in] x0, y0 The start of the line * @param[in] x1, y1 The end of the line * @param[in] color The color of the line * * @notapi */ void gdisp_lld_drawline(coord_t x0, coord_t y0, coord_t x1, coord_t y1, color_t color) { #if GDISP_NEED_VALIDATION /* Need to clip to screen */ #endif /* Code here */ } #endif #if GDISP_HARDWARE_BOX || defined(__DOXYGEN__) /** * @brief Draw a box. * @pre The GDISP unit must be in powerOn or powerSleep mode. * * @param[in] x0,y0 The start position * @param[in] cx,cy The size of the box (outside dimensions) * @param[in] color The color to use * @param[in] filled Should the box should be filled * * @notapi */ void gdisp_lld_drawbox(coord_t x, coord_t y, coord_t cx, coord_t cy, color_t color) { #if GDISP_NEED_VALIDATION /* Need to clip to screen */ #endif /* Code here */ } #endif #if GDISP_HARDWARE_FILLS || defined(__DOXYGEN__) /** * @brief Fill an area with a color. * @note Optional - The high level driver can emulate using software. * * @param[in] x, y The start filled area * @param[in] cx, cy The width and height to be filled * @param[in] color The color of the fill * * @notapi */ void gdisp_lld_fillarea(coord_t x, coord_t y, coord_t cx, coord_t cy, color_t color) { #if GDISP_NEED_VALIDATION if (cx < 1 || cy < 1 || x >= GDISP1.Width || y >= GDISP1.Height) return; if (x+cx > GDISP1.Width) cx = GDISP1.Width - x; if (y+cy > GDISP1.Height) cy = GDISP1.Height - y; #endif /* Code here */ } #endif #if GDISP_HARDWARE_BITFILLS || defined(__DOXYGEN__) /** * @brief Fill an area with a bitmap. * @note Optional - The high level driver can emulate using software. * * @param[in] x, y The start filled area * @param[in] cx, cy The width and height to be filled * @param[in] buffer The pixels to use to fill the area. * * @notapi */ void gdisp_lld_blitarea(coord_t x, coord_t y, coord_t cx, coord_t cy, pixel_t *buffer) { #if GDISP_NEED_VALIDATION if (cx < 1 || cy < 1 || x >= GDISP1.Width || y >= GDISP1.Height) return; if (x+cx > GDISP1.Width || y+cy > GDISP1.Height) return; #endif /* Code here */ } #endif /* Circular Drawing Functions */ #if (GDISP_NEED_CIRCLE && GDISP_HARDWARE_CIRCLES) || defined(__DOXYGEN__) /** * @brief Draw a circle. * @note Optional - The high level driver can emulate using software. * @note If GDISP_NEED_CLIPPING is defined this routine MUST behave * correctly if the circle is over the edges of the screen. * * @param[in] x, y The centre of the circle * @param[in] radius The radius of the circle * @param[in] color The color of the circle * * @notapi */ void gdisp_lld_drawcircle(coord_t x, coord_t y, coord_t radius, color_t color) { #if GDISP_NEED_VALIDATION /* Code here */ #endif /* Code here */ } #endif #if (GDISP_NEED_CIRCLE && GDISP_HARDWARE_CIRCLEFILLS) || defined(__DOXYGEN__) /** * @brief Create a filled circle. * @note Optional - The high level driver can emulate using software. * @note If GDISP_NEED_CLIPPING is defined this routine MUST behave * correctly if the circle is over the edges of the screen. * * @param[in] x, y The centre of the circle * @param[in] radius The radius of the circle * @param[in] color The color of the circle * * @notapi */ void gdisp_lld_fillcircle(coord_t x, coord_t y, coord_t radius, color_t color) { #if GDISP_NEED_VALIDATION /* Code here */ #endif /* Code here */ } #endif #if (GDISP_NEED_ELLIPSE && GDISP_HARDWARE_ELLIPSES) || defined(__DOXYGEN__) /** * @brief Draw an ellipse. * @note Optional - The high level driver can emulate using software. * @note If GDISP_NEED_CLIPPING is defined this routine MUST behave * correctly if the ellipse is over the edges of the screen. * * @param[in] x, y The centre of the ellipse * @param[in] a, b The dimensions of the ellipse * @param[in] color The color of the ellipse * * @notapi */ void gdisp_lld_drawellipse(coord_t x, coord_t y, coord_t a, coord_t b, color_t color) { #if GDISP_NEED_VALIDATION /* Code here */ #endif /* Code here */ } #endif #if (GDISP_NEED_ELLIPSE && GDISP_HARDWARE_ELLIPSEFILLS) || defined(__DOXYGEN__) /** * @brief Create a filled ellipse. * @note Optional - The high level driver can emulate using software. * @note If GDISP_NEED_CLIPPING is defined this routine MUST behave * correctly if the ellipse is over the edges of the screen. * * @param[in] x, y The centre of the ellipse * @param[in] a, b The dimensions of the ellipse * @param[in] color The color of the ellipse * * @notapi */ void gdisp_lld_fillellipse(coord_t x, coord_t y, coord_t a, coord_t b, color_t color) { #if GDISP_NEED_VALIDATION /* Code here */ #endif /* Code here */ } #endif #if (GDISP_NEED_TEXT && GDISP_HARDWARE_TEXT) || defined(__DOXYGEN__) /** * @brief Draw a character using a transparent background. * @note Optional - The high level driver can emulate using software. * * @param[in] x, y The top-left corner of the text * @param[in] c The character to print * @param[in] color The color of the character * * @notapi */ void gdisp_lld_drawchar(coord_t x, coord_t y, char c, font_t font, color_t color) { #if GDISP_NEED_VALIDATION /* Code here */ #endif /* Code here */ } #endif #if (GDISP_NEED_TEXT && GDISP_HARDWARE_TEXTFILLS) || defined(__DOXYGEN__) /** * @brief Draw a character using a filled background. * @note Optional - The high level driver can emulate using software. * * @param[in] x, y The top-left corner of the text * @param[in] c The character to print * @param[in] color The color of the character * @param[in] bgcolor The background color * * @notapi */ void gdisp_lld_fillchar(coord_t x, coord_t y, char c, font_t font, color_t color, color_t bgcolor) { #if GDISP_NEED_VALIDATION /* Code here */ #endif /* Code here */ } #endif #if (GDISP_NEED_PIXELREAD && GDISP_HARDWARE_PIXELREAD) || defined(__DOXYGEN__) /** * @brief Get the color of a particular pixel. * @note Optional. * @note If x,y is off the screen, the result is undefined. * * @param[in] x, y The start of the text * * @notapi */ color_t gdisp_lld_getpixelcolor(coord_t x, coord_t y) { #if GDISP_NEED_VALIDATION if (x >= GDISP1.Width || y >= GDISP1.Height) return 0; #endif /* Code here */ } #endif #if (GDISP_NEED_SCROLL && GDISP_HARDWARE_SCROLL) || defined(__DOXYGEN__) /** * @brief Scroll vertically a section of the screen. * @note Optional. * @note If x,y + cx,cy is off the screen, the result is undefined. * @note If lines is >= cy, it is equivelent to a area fill with bgcolor. * * @param[in] x, y The start of the area to be scrolled * @param[in] cx, cy The size of the area to be scrolled * @param[in] lines The number of lines to scroll (Can be positive or negative) * @param[in] bgcolor The color to fill the newly exposed area. * * @notapi */ void gdisp_lld_verticalscroll(coord_t x, coord_t y, coord_t cx, coord_t cy, int lines, color_t bgcolor) { #if GDISP_NEED_VALIDATION if (cx < 1 || cy < 1 || x >= GDISP1.Width || y >= GDISP1.Height) return; if (x+cx > GDISP1.Width) cx = GDISP1.Width - x; if (y+cy > GDISP1.Height) cy = GDISP1.Height - y; #endif /* Code here */ } #endif #endif /* HAL_USE_GDISP */ /** @} */