GUIDRV_SSD1926_Private.h

00001 /*********************************************************************
00002 *                SEGGER Microcontroller GmbH & Co. KG                *
00003 *        Solutions for real time microcontroller applications        *
00004 **********************************************************************
00005 *                                                                    *
00006 *        (c) 1996 - 2016  SEGGER Microcontroller GmbH & Co. KG       *
00007 *                                                                    *
00008 *        Internet: www.segger.com    Support:  support@segger.com    *
00009 *                                                                    *
00010 **********************************************************************
00011 
00012 ** emWin V5.38 - Graphical user interface for embedded applications **
00013 All  Intellectual Property rights  in the Software belongs to  SEGGER.
00014 emWin is protected by  international copyright laws.  Knowledge of the
00015 source code may not be used to write a similar product.  This file may
00016 only be used in accordance with the following terms:
00017 
00018 The software has been licensed to  NXP Semiconductors USA, Inc.  whose
00019 registered  office  is  situated  at 411 E. Plumeria Drive, San  Jose,
00020 CA 95134, USA  solely for  the  purposes  of  creating  libraries  for
00021 NXPs M0, M3/M4 and  ARM7/9 processor-based  devices,  sublicensed  and
00022 distributed under the terms and conditions of the NXP End User License
00023 Agreement.
00024 Full source code is available at: www.segger.com
00025 
00026 We appreciate your understanding and fairness.
00027 ----------------------------------------------------------------------
00028 Licensing information
00029 
00030 Licensor:                 SEGGER Microcontroller Systems LLC
00031 Licensed to:              NXP Semiconductors, 1109 McKay Dr, M/S 76, San Jose, CA 95131, USA
00032 Licensed SEGGER software: emWin
00033 License number:           GUI-00186
00034 License model:            emWin License Agreement, dated August 20th 2011
00035 Licensed product:         -
00036 Licensed platform:        NXP's ARM 7/9, Cortex-M0,M3,M4
00037 Licensed number of seats: -
00038 ----------------------------------------------------------------------
00039 File        : GUIDRV_SSD1926_Private.h
00040 Purpose     : Interface definition for GUIDRV_SSD1926 driver
00041 ---------------------------END-OF-HEADER------------------------------
00042 */
00043 
00044 #include "GUIDRV_SSD1926.h"
00045 #include "GUIDRV_NoOpt_1_8.h"
00046 
00047 #ifndef GUIDRV_SSD1926_PRIVATE_H
00048 #define GUIDRV_SSD1926_PRIVATE_H
00049 
00050 #if defined(__cplusplus)
00051 extern "C" {     /* Make sure we have C-declarations in C++ programs */
00052 #endif
00053 
00054 /*********************************************************************
00055 *
00056 *       Defines
00057 *
00058 **********************************************************************
00059 */
00060 //
00061 // Use unique context identified
00062 //
00063 #define DRIVER_CONTEXT DRIVER_CONTEXT_SSD1926
00064 
00065 /*********************************************************************
00066 *
00067 *       Types
00068 *
00069 **********************************************************************
00070 */
00071 typedef struct DRIVER_CONTEXT DRIVER_CONTEXT;
00072 
00073 /*********************************************************************
00074 *
00075 *       MANAGE_VRAM_CONTEXT
00076 */
00077 typedef struct {
00078   //
00079   // Function pointers for writing to display controller
00080   //
00081   void (* pfWriteReg)  (DRIVER_CONTEXT * pContext, U16 Reg, U16 Data);
00082   void (* pfWriteAddrW)(DRIVER_CONTEXT * pContext, U32 Addr);
00083   void (* pfWriteAddrB)(DRIVER_CONTEXT * pContext, U32 Addr);
00084   void (* pfWrite8)    (DRIVER_CONTEXT * pContext, U8  Data);
00085   void (* pfSetAddr)   (DRIVER_CONTEXT * pContext, U32 Addr);
00086   U8   (* pfRead8)     (DRIVER_CONTEXT * pContext, U32 Addr);
00087   void (* pfFlush)     (DRIVER_CONTEXT * pContext);
00088 } MANAGE_VMEM_API;
00089 
00090 /*********************************************************************
00091 *
00092 *       DRIVER_CONTEXT
00093 */
00094 struct DRIVER_CONTEXT {
00095   //
00096   // Common data
00097   //
00098   int xSize, ySize;
00099   int vxSize, vySize;
00100   int UseCache;
00101   int MemSize;
00102   //
00103   // Driver specific data
00104   //
00105   int FirstSEG;
00106   int FirstCOM;
00107   //
00108   // Accelerators for calculation
00109   //
00110   int BytesPerLine;
00111   int BitsPerPixel;
00112   //
00113   // VRAM
00114   //
00115   U8 * pVMEM;
00116   //
00117   // Colors
00118   //
00119   U32 * pColors;
00120   //
00121   // Buffer for one line of data
00122   //
00123   U16 * aBuffer;        // Allocated buffer
00124   U16 * pBuffer;        // Pointer for writing operations
00125   int NumBytesInBuffer; // Number of bytes in buffer
00126   U32 Addr;             // Destination address of buffer
00127   int Odd;              // 1 if the next address to be written is odd
00128   //
00129   // Pointer to driver internal initialization routine
00130   //
00131   void (* pfInit) (GUI_DEVICE * pDevice);
00132   void (* pfCheck)(GUI_DEVICE * pDevice);
00133   //
00134   // API-Tables
00135   //
00136   MANAGE_VMEM_API ManageVMEM_API; // Memory management
00137   GUI_PORT_API    HW_API;         // Hardware routines
00138 };
00139 
00140 /*********************************************************************
00141 *
00142 *       Access macros
00143 */
00144 #define LCD_WRITE_A0(Data)             pContext->HW_API.pfWrite8_A0(Data)
00145 #define LCD_WRITE_A1(Data)             pContext->HW_API.pfWrite8_A1(Data)
00146 #define LCD_WRITEM_A0(pData, NumItems) pContext->HW_API.pfWriteM8_A0(pData, NumItems)
00147 #define LCD_WRITEM_A1(pData, NumItems) pContext->HW_API.pfWriteM8_A1(pData, NumItems)
00148 #define LCD_READ_A1(Data)              Data = pContext->HW_API.pfRead8_A1()
00149 
00150 /*********************************************************************
00151 *
00152 *       LOG2PHYS_xxx
00153 */
00154 #define LOG2PHYS_X      (                  x    )
00155 #define LOG2PHYS_X_OX   (pContext->xSize - x - 1)
00156 #define LOG2PHYS_X_OY   (                  x    )
00157 #define LOG2PHYS_X_OXY  (pContext->xSize - x - 1)
00158 #define LOG2PHYS_X_OS   (                  y    )
00159 #define LOG2PHYS_X_OSX  (pContext->ySize - y - 1)
00160 #define LOG2PHYS_X_OSY  (                  y    )
00161 #define LOG2PHYS_X_OSXY (pContext->ySize - y - 1)
00162 
00163 #define LOG2PHYS_Y      (                  y    )
00164 #define LOG2PHYS_Y_OX   (                  y    )
00165 #define LOG2PHYS_Y_OY   (pContext->ySize - y - 1)
00166 #define LOG2PHYS_Y_OXY  (pContext->ySize - y - 1)
00167 #define LOG2PHYS_Y_OS   (                  x    )
00168 #define LOG2PHYS_Y_OSX  (                  x    )
00169 #define LOG2PHYS_Y_OSY  (pContext->xSize - x - 1)
00170 #define LOG2PHYS_Y_OSXY (pContext->xSize - x - 1)
00171 
00172 /*********************************************************************
00173 *
00174 *       _SetPixelIndex_##EXT
00175 */
00176 #define DEFINE_SETPIXELINDEX(EXT, X_PHYS, Y_PHYS)                                                 \
00177 static void _SetPixelIndex_##EXT(GUI_DEVICE * pDevice, int x, int y, LCD_PIXELINDEX PixelIndex) { \
00178   DRIVER_CONTEXT * pContext;                                                                      \
00179                                                                                                   \
00180   pContext = (DRIVER_CONTEXT *)pDevice->u.pContext;                                               \
00181   _SetPixelIndex(pContext, X_PHYS, Y_PHYS, PixelIndex);                                           \
00182 }
00183 
00184 /*********************************************************************
00185 *
00186 *       _GetPixelIndex_##EXT
00187 */
00188 #define DEFINE_GETPIXELINDEX(EXT, X_PHYS, Y_PHYS)                                \
00189 static LCD_PIXELINDEX _GetPixelIndex_##EXT(GUI_DEVICE * pDevice, int x, int y) { \
00190   DRIVER_CONTEXT * pContext;                                                     \
00191   LCD_PIXELINDEX PixelIndex;                                                     \
00192                                                                                  \
00193   pContext = (DRIVER_CONTEXT *)pDevice->u.pContext;                              \
00194   PixelIndex = _GetPixelIndex(pContext, X_PHYS, Y_PHYS);                         \
00195   return PixelIndex;                                                             \
00196 }
00197 
00198 /*********************************************************************
00199 *
00200 *       _GetDevProp_##EXT
00201 */
00202 #define DEFINE_GETDEVPROP(EXT, MX, MY, SWAP)                    \
00203 static I32 _GetDevProp_##EXT(GUI_DEVICE * pDevice, int Index) { \
00204   switch (Index) {                                              \
00205   case LCD_DEVCAP_MIRROR_X: return MX;                          \
00206   case LCD_DEVCAP_MIRROR_Y: return MY;                          \
00207   case LCD_DEVCAP_SWAP_XY:  return SWAP;                        \
00208   }                                                             \
00209   return _GetDevProp(pDevice, Index);                           \
00210 }
00211 
00212 /*********************************************************************
00213 *
00214 *       DEFINE_FUNCTIONS
00215 */
00216 #define DEFINE_FUNCTIONS(EXT, X_PHYS, Y_PHYS, MX, MY, SWAP) \
00217   DEFINE_SETPIXELINDEX(EXT, X_PHYS, Y_PHYS)                 \
00218   DEFINE_GETPIXELINDEX(EXT, X_PHYS, Y_PHYS)                 \
00219   DEFINE_GETDEVPROP(EXT, MX, MY, SWAP)                      \
00220   DEFINE_GUI_DEVICE_API(EXT)
00221 
00222 /*********************************************************************
00223 *
00224 *       Private functions
00225 *
00226 **********************************************************************
00227 */
00228 void (*GUIDRV__SSD1926_GetDevFunc(GUI_DEVICE ** ppDevice, int Index))(void);
00229 void   GUIDRV__SSD1926_SetOrg    (GUI_DEVICE *  pDevice,  int x, int y);
00230 I32    GUIDRV__SSD1926_GetDevProp(GUI_DEVICE *  pDevice,  int Index);
00231 void   GUIDRV__SSD1926_GetRect   (GUI_DEVICE *  pDevice,  LCD_RECT * pRect);
00232 
00233 #if defined(__cplusplus)
00234 }
00235 #endif
00236 
00237 #endif
00238 
00239 /*************************** End of file ****************************/