aboutsummaryrefslogtreecommitdiffstats
path: root/halext/include/gdisp.h
diff options
context:
space:
mode:
Diffstat (limited to 'halext/include/gdisp.h')
-rw-r--r--halext/include/gdisp.h310
1 files changed, 116 insertions, 194 deletions
diff --git a/halext/include/gdisp.h b/halext/include/gdisp.h
index 258cc8b5..24a8b1b4 100644
--- a/halext/include/gdisp.h
+++ b/halext/include/gdisp.h
@@ -17,6 +17,13 @@
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
+/**
+ * @file gdisp.h
+ * @brief GDISP Graphic Driver subsystem header file.
+ *
+ * @addtogroup GDISP
+ * @{
+ */
#ifndef _GDISP_H
#define _GDISP_H
@@ -52,6 +59,26 @@
#define Pink HTML2COLOR(0xFFC0CB)
#define SkyBlue HTML2COLOR(0x87CEEB)
+/**
+ * @brief Driver Control Constants
+ * @detail Unsupported control codes are ignored.
+ * @note The value parameter should always be typecast to (void *).
+ * @note There are some predefined and some specific to the low level driver.
+ * @note GDISP_CONTROL_POWER - Takes a gdisp_powermode_t
+ * GDISP_CONTROL_ORIENTATION - Takes a gdisp_orientation_t
+ * GDISP_CONTROL_BACKLIGHT - Takes an int from 0 to 100. For a driver
+ * that only supports off/on anything other
+ * than zero is on.
+ * GDISP_CONTROL_CONTRAST - Takes an int from 0 to 100.
+ * GDISP_CONTROL_LLD - Low level driver control constants start at
+ * this value.
+ */
+#define GDISP_CONTROL_POWER 0
+#define GDISP_CONTROL_ORIENTATION 1
+#define GDISP_CONTROL_BACKLIGHT 2
+#define GDISP_CONTROL_CONTRAST 3
+#define GDISP_CONTROL_LLD 1000
+
/*===========================================================================*/
/* Driver pre-compile time settings. */
/*===========================================================================*/
@@ -60,208 +87,91 @@
* @name GDISP more complex functionality to be compiled
* @{
*/
-/**
- * @brief Should all operations be clipped to the screen and colors validated.
- * @details Defaults to TRUE.
- * @note If this is FALSE, any operations that extend beyond the
- * edge of the screen will have undefined results. Any
- * out-of-range colors will produce undefined results.
- * @note If defined then all low level and high level driver routines
- * must check the validity of inputs and do something sensible
- * if they are out of range. It doesn't have to be efficient,
- * just valid.
- */
-#ifndef GDISP_NEED_VALIDATION
- #define GDISP_NEED_VALIDATION TRUE
-#endif
-
-/**
- * @brief Are circle functions needed.
- * @details Defaults to TRUE
- */
-#ifndef GDISP_NEED_CIRCLE
- #define GDISP_NEED_CIRCLE TRUE
-#endif
-
-/**
- * @brief Are ellipse functions needed.
- * @details Defaults to TRUE
- */
-#ifndef GDISP_NEED_ELLIPSE
- #define GDISP_NEED_ELLIPSE TRUE
-#endif
-
-/**
- * @brief Are text functions needed.
- * @details Defaults to TRUE
- */
-#ifndef GDISP_NEED_TEXT
- #define GDISP_NEED_TEXT TRUE
-#endif
-
-/**
- * @brief Is scrolling needed.
- * @details Defaults to FALSE
- */
-#ifndef GDISP_NEED_SCROLL
- #define GDISP_NEED_SCROLL FALSE
-#endif
-
-/**
- * @brief Is the capability to read pixels back needed.
- * @details Defaults to FALSE
- */
-#ifndef GDISP_NEED_PIXELREAD
- #define GDISP_NEED_PIXELREAD FALSE
-#endif
-
-/**
- * @brief Do the drawing functions need to be thread-safe.
- * @details Defaults to FALSE
- * @note Turning this on adds two context switches per transaction
- * so it can significantly slow graphics drawing.
- */
-#ifndef GDISP_NEED_MULTITHREAD
- #define GDISP_NEED_MULTITHREAD FALSE
-#endif
-/** @} */
-
-/* Include the low level driver configuration information */
-#include "gdisp_lld_config.h"
-
-/*===========================================================================*/
-/* Derived constants and error checks. */
-/*===========================================================================*/
-
-#if GDISP_NEED_SCROLL && !GDISP_HARDWARE_SCROLL
- #error "GDISP: Hardware scrolling is wanted but not supported."
-#endif
-
-#if GDISP_NEED_PIXELREAD && !GDISP_HARDWARE_PIXELREAD
- #error "GDISP: Pixel read-back is wanted but not supported."
-#endif
-
-/*===========================================================================*/
-/* Driver data structures and types. */
-/*===========================================================================*/
-
-/* Define the basic Macro's for the various pixel formats */
-
-#if defined(GDISP_PIXELFORMAT_RGB565) || defined(__DOXYGEN__)
/**
- * @brief The color of a pixel.
+ * @brief Should all operations be clipped to the screen and colors validated.
+ * @details Defaults to TRUE.
+ * @note If this is FALSE, any operations that extend beyond the
+ * edge of the screen will have undefined results. Any
+ * out-of-range colors will produce undefined results.
+ * @note If defined then all low level and high level driver routines
+ * must check the validity of inputs and do something sensible
+ * if they are out of range. It doesn't have to be efficient,
+ * just valid.
*/
- typedef uint16_t color_t;
+ #ifndef GDISP_NEED_VALIDATION
+ #define GDISP_NEED_VALIDATION TRUE
+ #endif
+
/**
- * @brief Convert a number (of any type) to a color_t.
- * @details Masks any invalid bits in the color
+ * @brief Are circle functions needed.
+ * @details Defaults to TRUE
*/
- #define COLOR(c) ((color_t)(c))
+ #ifndef GDISP_NEED_CIRCLE
+ #define GDISP_NEED_CIRCLE TRUE
+ #endif
+
/**
- * @brief Does the color_t type contain invalid bits that need masking.
+ * @brief Are ellipse functions needed.
+ * @details Defaults to TRUE
*/
- #define MASKCOLOR FALSE
+ #ifndef GDISP_NEED_ELLIPSE
+ #define GDISP_NEED_ELLIPSE TRUE
+ #endif
+
/**
- * @brief Convert red, green, blue (each 0 to 255) into a color value.
+ * @brief Are text functions needed.
+ * @details Defaults to TRUE
*/
- #define RGB2COLOR(r,g,b) ((color_t)((((r) & 0xF8)<<8) | (((g) & 0xFC)<<3) | (((b) & 0xF8)>>3)))
+ #ifndef GDISP_NEED_TEXT
+ #define GDISP_NEED_TEXT TRUE
+ #endif
+
/**
- * @brief Convert a 6 digit HTML code (hex) into a color value.
+ * @brief Is scrolling needed.
+ * @details Defaults to FALSE
*/
- #define HTML2COLOR(h) ((color_t)((((h) & 0xF80000)>>8) | (((h) & 0x00FC00)>>5) | (((h) & 0x0000F8)>>3)))
+ #ifndef GDISP_NEED_SCROLL
+ #define GDISP_NEED_SCROLL FALSE
+ #endif
+
/**
- * @brief Extract the red component (0 to 255) of a color value.
+ * @brief Is the capability to read pixels back needed.
+ * @details Defaults to FALSE
*/
- #define RED_OF(c) (((c) & 0xF800)>>8)
+ #ifndef GDISP_NEED_PIXELREAD
+ #define GDISP_NEED_PIXELREAD FALSE
+ #endif
+
/**
- * @brief Extract the green component (0 to 255) of a color value.
+ * @brief Control some aspect of the drivers operation.
+ * @details Defaults to FALSE
*/
- #define GREEN_OF(c) (((c)&0x007E)>>3)
+ #ifndef GDISP_NEED_CONTROL
+ #define GDISP_NEED_CONTROL FALSE
+ #endif
+
/**
- * @brief Extract the blue component (0 to 255) of a color value.
+ * @brief Do the drawing functions need to be thread-safe.
+ * @details Defaults to FALSE
+ * @note Turning this on adds two context switches per transaction
+ * so it can significantly slow graphics drawing.
*/
- #define BLUE_OF(c) (((c)&0x001F)<<3)
-
-#elif defined(GDISP_PIXELFORMAT_RGB888)
- typedef uint32_t color_t;
- #define COLOR(c) ((color_t)(((c) & 0xFFFFFF)))
- #define MASKCOLOR TRUE
- #define RGB2COLOR(r,g,b) ((color_t)((((r) & 0xFF)<<16) | (((g) & 0xFF) << 8) | ((b) & 0xFF)))
- #define HTML2COLOR(h) ((color_t)(h))
- #define RED_OF(c) (((c) & 0xFF0000)>>16)
- #define GREEN_OF(c) (((c)&0x00FF00)>>8)
- #define BLUE_OF(c) ((c)&0x0000FF)
-
-#elif defined(GDISP_PIXELFORMAT_RGB444)
- typedef uint16_t color_t;
- #define COLOR(c) ((color_t)(((c) & 0x0FFF)))
- #define MASKCOLOR TRUE
- #define RGB2COLOR(r,g,b) ((color_t)((((r) & 0xF0)<<4) | ((g) & 0xF0) | (((b) & 0xF0)>>4)))
- #define HTML2COLOR(h) ((color_t)((((h) & 0xF00000)>>12) | (((h) & 0x00F000)>>8) | (((h) & 0x0000F0)>>4)))
- #define RED_OF(c) (((c) & 0x0F00)>>4)
- #define GREEN_OF(c) ((c)&0x00F0)
- #define BLUE_OF(c) (((c)&0x000F)<<4)
-
-#elif defined(GDISP_PIXELFORMAT_RGB332)
- typedef uint8_t color_t;
- #define COLOR(c) ((color_t)(c))
- #define MASKCOLOR FALSE
- #define RGB2COLOR(r,g,b) ((color_t)(((r) & 0xE0) | (((g) & 0xE0)>>3) | (((b) & 0xC0)>>6)))
- #define HTML2COLOR(h) ((color_t)((((h) & 0xE00000)>>16) | (((h) & 0x00E000)>>11) | (((h) & 0x0000C0)>>6)))
- #define RED_OF(c) ((c) & 0xE0)
- #define GREEN_OF(c) (((c)&0x1C)<<3)
- #define BLUE_OF(c) (((c)&0x03)<<6)
-
-#elif defined(GDISP_PIXELFORMAT_RGB666)
- typedef uint32_t color_t;
- #define COLOR(c) ((color_t)(((c) & 0x03FFFF)))
- #define MASKCOLOR TRUE
- #define RGB2COLOR(r,g,b) ((color_t)((((r) & 0xFC)<<10) | (((g) & 0xFC)<<4) | (((b) & 0xFC)>>2)))
- #define HTML2COLOR(h) ((color_t)((((h) & 0xFC0000)>>6) | (((h) & 0x00FC00)>>4) | (((h) & 0x0000FC)>>2)))
- #define RED_OF(c) (((c) & 0x03F000)>>12)
- #define GREEN_OF(c) (((c)&0x00FC00)>>8)
- #define BLUE_OF(c) (((c)&0x00003F)<<2)
-
-#elif !defined(GDISP_PIXELFORMAT_CUSTOM)
- #error "GDISP: No supported pixel format has been specified."
-#endif
+ #ifndef GDISP_NEED_MULTITHREAD
+ #define GDISP_NEED_MULTITHREAD FALSE
+ #endif
+/** @} */
-/* Verify information for packed pixels and define a non-packed pixel macro */
-#if !GDISP_PACKED_PIXELS
- #define gdispPackPixels(buf,cx,x,y,c) { ((color_t *)(buf))[(y)*(cx)+(x)] = (c); }
-#elif !GDISP_HARDWARE_BITFILLS
- #error "GDISP: packed pixel formats are only supported for hardware accelerated drivers."
-#elif !defined(GDISP_PIXELFORMAT_RGB888) \
- && !defined(GDISP_PIXELFORMAT_RGB444) \
- && !defined(GDISP_PIXELFORMAT_RGB666) \
- && !defined(GDISP_PIXELFORMAT_CUSTOM)
- #error "GDISP: A packed pixel format has been specified for an unsupported pixel format."
-#endif
+/*===========================================================================*/
+/* Low Level Driver details and error checks. */
+/*===========================================================================*/
+
+/* Include the low level driver information */
+#include "gdisp_lld.h"
+
+/*===========================================================================*/
+/* Type definitions */
+/*===========================================================================*/
-/**
- * @brief The type for a coordinate or length on the screen.
- */
-typedef uint16_t coord_t;
-/**
- * @brief The type of a pixel.
- */
-typedef color_t pixel_t;
-/**
- * @brief The type of a font.
- */
-typedef const struct font *font_t;
-/**
- * @brief Type of a structure representing a GDISP driver.
- */
-typedef struct GDISPDriver GDISPDriver;
-/**
- * @brief Type for the screen orientation.
- */
-typedef enum orientation {portrait, landscape, portraitInv, landscapeInv} gdisp_orientation_t;
-/**
- * @brief Type for the available power modes for the screen.
- */
-typedef enum powermode {powerOff, powerSleep, powerOn} gdisp_powermode_t;
/**
* @brief Type for the text justification.
*/
@@ -271,23 +181,29 @@ typedef enum justify {justifyLeft, justifyCenter, justifyRight} justify_t;
*/
typedef enum fontmetric {fontHeight, fontDescendersHeight, fontLineSpacing, fontCharPadding, fontMinWidth, fontMaxWidth} fontmetric_t;
-
/*===========================================================================*/
/* External declarations. */
/*===========================================================================*/
-/* Include the low level driver information */
-#include "gdisp_lld.h"
-
#if GDISP_NEED_TEXT || defined(__DOXYGEN__)
/**
* @brief Predefined fonts.
*/
extern const struct font fontSmall;
+extern const struct font fontSmallDouble;
+extern const struct font fontSmallNarrow;
extern const struct font fontLarger;
+extern const struct font fontLargerDouble;
+extern const struct font fontLargerNarrow;
extern const struct font fontUI1;
+extern const struct font fontUI1Double;
+extern const struct font fontUI1Narrow;
extern const struct font fontUI2;
+extern const struct font fontUI2Double;
+extern const struct font fontUI2Narrow;
extern const struct font fontLargeNumbers;
+extern const struct font fontLargeNumbersDouble;
+extern const struct font fontLargeNumbersNarrow;
#endif
#ifdef __cplusplus
@@ -298,14 +214,11 @@ extern "C" {
/* Base Functions */
void gdispInit(GDISPDriver *gdisp);
- void gdispSetPowerMode(gdisp_powermode_t powerMode);
- void gdispSetOrientation(gdisp_orientation_t newOrientation);
/* Drawing Functions */
void gdispClear(color_t color);
void gdispDrawPixel(coord_t x, coord_t y, color_t color);
void gdispDrawLine(coord_t x0, coord_t y0, coord_t x1, coord_t y1, color_t color);
- void gdispDrawBox(coord_t x, coord_t y, coord_t cx, coord_t cy, color_t color);
void gdispFillArea(coord_t x, coord_t y, coord_t cx, coord_t cy, color_t color);
void gdispBlitArea(coord_t x, coord_t y, coord_t cx, coord_t cy, const pixel_t *buffer);
@@ -337,16 +250,18 @@ extern "C" {
void gdispVerticalScroll(coord_t x, coord_t y, coord_t cx, coord_t cy, int lines, color_t bgcolor);
#endif
+ /* Set driver specific control */
+ #if GDISP_NEED_CONTROL
+ void gdispControl(unsigned what, void *value);
+ #endif
+
#else
/* The same as above but use the low level driver directly if no multi-thread support is needed */
#define gdispInit(gdisp) gdisp_lld_init()
- #define gdispSetPowerMode(powerMode) gdisp_lld_setpowermode(powerMode)
- #define gdispSetOrientation(newOrientation) gdisp_lld_setorientation(newOrientation)
#define gdispClear(color) gdisp_lld_clear(color)
#define gdispDrawPixel(x, y, color) gdisp_lld_drawpixel(x, y, color)
#define gdispDrawLine(x0, y0, x1, y1, color) gdisp_lld_drawline(x0, y0, x1, y1, color)
- #define gdispDrawBox(x, y, cx, cy, color) gdisp_lld_drawbox(x, y, cx, cy, color)
#define gdispFillArea(x, y, cx, cy, color) gdisp_lld_fillarea(x, y, cx, cy, color)
#define gdispBlitArea(x, y, cx, cy, buffer) gdisp_lld_blitarea(x, y, cx, cy, buffer)
#define gdispDrawCircle(x, y, radius, color) gdisp_lld_drawcircle(x, y, radius, color)
@@ -357,9 +272,12 @@ extern "C" {
#define gdispFillChar(x, y, c, font, color, bgcolor) gdisp_lld_fillchar(x, y, c, font, color, bgcolor)
#define gdispGetPixelColor(x, y) gdisp_lld_getpixelcolor(x, y)
#define gdispVerticalScroll(x, y, cx, cy, lines, bgcolor) gdisp_lld_verticalscroll(x, y, cx, cy, lines, bgcolor)
+ #define gdispControl(what, value) gdisp_lld_control(what, value)
#endif
+void gdispDrawBox(coord_t x, coord_t y, coord_t cx, coord_t cy, color_t color);
+
/* Extra Text Functions */
#if GDISP_NEED_TEXT
void gdispDrawString(coord_t x, coord_t y, const char *str, font_t font, color_t color);
@@ -375,6 +293,10 @@ extern "C" {
void gdispPackPixels(const pixel_t *buf, coord_t cx, coord_t x, coord_t y, color_t color);
#endif
+/* Deprecated Routines (already!) */
+#define gdispSetPowerMode(powerMode) gdispControl(GDISP_CONTROL_POWER, (void *)(powerMode))
+#define gdispSetOrientation(newOrientation) gdispControl(GDISP_CONTROL_ORITENTATION, (void *)(newOrientation))
+
#ifdef __cplusplus
}
#endif
generated by cgit v1.2.3 (git 2.25.1) at 2025-07-19 05:38:10 +0000