GUIDRV_S1D13748_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_S1D13748_Private.h
00040 Purpose     : Interface definition for GUIDRV_S1D13748 driver
00041 ---------------------------END-OF-HEADER------------------------------
00042 */
00043 
00044 #include "GUIDRV_S1D13748.h"
00045 #include "GUIDRV_NoOpt_1_8.h"
00046 
00047 #ifndef GUIDRV_S1D13748_PRIVATE_H
00048 #define GUIDRV_S1D13748_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 #ifndef   LCD_WRITE_BUFFER_SIZE
00061   #define LCD_WRITE_BUFFER_SIZE 500
00062 #endif
00063 
00064 /*********************************************************************
00065 *
00066 *       Types
00067 *
00068 **********************************************************************
00069 */
00070 typedef struct DRIVER_CONTEXT DRIVER_CONTEXT;
00071 
00072 /*********************************************************************
00073 *
00074 *       MANAGE_VMEM_API
00075 */
00076 typedef struct {
00077   //
00078   // Private function pointers
00079   //
00080   void (* pfSetAddrR)   (DRIVER_CONTEXT * pContext, int x, int y);                     // Sets the address to be read
00081   void (* pfSetAddrW)   (DRIVER_CONTEXT * pContext, int x, int y);                     // Sets the address to be written
00082   void (* pfSetRectR)   (DRIVER_CONTEXT * pContext, int x0, int y0, int x1, int y1);   // Sets the rectangular area to be read
00083   void (* pfSetRectW)   (DRIVER_CONTEXT * pContext, int x0, int y0, int x1, int y1);   // Sets the rectangular area to be written
00084   void (* pfFlushBuffer)(DRIVER_CONTEXT * pContext);                                   // Sends remaining data of the write buffer to the controller
00085   void (* pfWriteData)  (DRIVER_CONTEXT * pContext, U16 Data);                         // Writes one 16 bit data item using the write buffer
00086   void (* pfWriteDataM) (DRIVER_CONTEXT * pContext, U16 Data, U32 NumPixels);          // Writes a number of items of the same color using the write buffer
00087   void (* pfWriteDataMP)(DRIVER_CONTEXT * pContext, U16 const * pData, U32 NumPixels); // Writes data using the write buffer
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 xPos, yPos;
00101   int MemSize;
00102   int SwapXY;
00103   int XOff;
00104   U32 BufferOffset;
00105   int NumBytesInBuffer;
00106   int IsVisible;
00107   //
00108   // Driver specific data
00109   //
00110   int WriteBufferSize;
00111   int UseLayer;
00112   //
00113   // Accelerators for calculation
00114   //
00115   int BitsPerPixel;
00116   //
00117   // VRAM
00118   //
00119   U16 * pWriteBuffer;
00120   U16 * pWrite;
00121   //
00122   // API-Tables
00123   //
00124   MANAGE_VMEM_API ManageVMEM_API; // Memory management
00125   GUI_PORT_API    HW_API;         // Hardware routines
00126 };
00127 
00128 /*********************************************************************
00129 *
00130 *       LOG2PHYS_xxx
00131 */
00132 #define LOG2PHYS_X      (                  x    )
00133 #define LOG2PHYS_X_OX   (pContext->xSize - x - 1)
00134 #define LOG2PHYS_X_OY   (                  x    )
00135 #define LOG2PHYS_X_OXY  (pContext->xSize - x - 1)
00136 #define LOG2PHYS_X_OS   (                  y    )
00137 #define LOG2PHYS_X_OSX  (pContext->ySize - y - 1)
00138 #define LOG2PHYS_X_OSY  (                  y    )
00139 #define LOG2PHYS_X_OSXY (pContext->ySize - y - 1)
00140 
00141 #define LOG2PHYS_Y      (                  y    )
00142 #define LOG2PHYS_Y_OX   (                  y    )
00143 #define LOG2PHYS_Y_OY   (pContext->ySize - y - 1)
00144 #define LOG2PHYS_Y_OXY  (pContext->ySize - y - 1)
00145 #define LOG2PHYS_Y_OS   (                  x    )
00146 #define LOG2PHYS_Y_OSX  (                  x    )
00147 #define LOG2PHYS_Y_OSY  (pContext->xSize - x - 1)
00148 #define LOG2PHYS_Y_OSXY (pContext->xSize - x - 1)
00149 
00150 /*********************************************************************
00151 *
00152 *       _SetPixelIndex_##EXT
00153 */
00154 #define DEFINE_SETPIXELINDEX(EXT, X_PHYS, Y_PHYS)                                                 \
00155 static void _SetPixelIndex_##EXT(GUI_DEVICE * pDevice, int x, int y, LCD_PIXELINDEX PixelIndex) { \
00156   DRIVER_CONTEXT * pContext;                                                                      \
00157                                                                                                   \
00158   pContext = (DRIVER_CONTEXT *)pDevice->u.pContext;                                               \
00159   _SetPixelIndex(pContext, X_PHYS, Y_PHYS, PixelIndex);                                           \
00160 }
00161 
00162 /*********************************************************************
00163 *
00164 *       _GetPixelIndex_##EXT
00165 */
00166 #define DEFINE_GETPIXELINDEX(EXT, X_PHYS, Y_PHYS)                                \
00167 static LCD_PIXELINDEX _GetPixelIndex_##EXT(GUI_DEVICE * pDevice, int x, int y) { \
00168   DRIVER_CONTEXT * pContext;                                                     \
00169   LCD_PIXELINDEX PixelIndex;                                                     \
00170                                                                                  \
00171   pContext = (DRIVER_CONTEXT *)pDevice->u.pContext;                              \
00172   PixelIndex = _GetPixelIndex(pContext, X_PHYS, Y_PHYS);                         \
00173   return PixelIndex;                                                             \
00174 }
00175 
00176 /*********************************************************************
00177 *
00178 *       _GetDevProp_##EXT
00179 */
00180 #define DEFINE_GETDEVPROP(EXT, MX, MY, SWAP)                    \
00181 static I32 _GetDevProp_##EXT(GUI_DEVICE * pDevice, int Index) { \
00182   switch (Index) {                                              \
00183   case LCD_DEVCAP_MIRROR_X: return MX;                          \
00184   case LCD_DEVCAP_MIRROR_Y: return MY;                          \
00185   case LCD_DEVCAP_SWAP_XY:  return SWAP;                        \
00186   }                                                             \
00187   return _GetDevProp(pDevice, Index);                           \
00188 }
00189 
00190 /*********************************************************************
00191 *
00192 *       DEFINE_FUNCTIONS
00193 */
00194 #define DEFINE_FUNCTIONS(EXT, X_PHYS, Y_PHYS, MX, MY, SWAP) \
00195   DEFINE_SETPIXELINDEX(EXT, X_PHYS, Y_PHYS)                 \
00196   DEFINE_GETPIXELINDEX(EXT, X_PHYS, Y_PHYS)                 \
00197   DEFINE_GETDEVPROP(EXT, MX, MY, SWAP)                      \
00198   DEFINE_GUI_DEVICE_API(EXT)
00199 
00200 /*********************************************************************
00201 *
00202 *       Private functions
00203 *
00204 **********************************************************************
00205 */
00206 void (*GUIDRV__S1D13748_GetDevFunc(GUI_DEVICE ** ppDevice, int Index))(void);
00207 void   GUIDRV__S1D13748_SetOrg    (GUI_DEVICE *  pDevice,  int x, int y);
00208 I32    GUIDRV__S1D13748_GetDevProp(GUI_DEVICE *  pDevice,  int Index);
00209 void   GUIDRV__S1D13748_GetRect   (GUI_DEVICE *  pDevice,  LCD_RECT * pRect);
00210 
00211 #if defined(__cplusplus)
00212 }
00213 #endif
00214 
00215 #endif /* GUIDRV_S1D13748_PRIVATE_H */
00216 
00217 /*************************** End of file ****************************/