csl_lcdc.h

Go to the documentation of this file.

/*  ===========================================================================
 *   Copyright (c) Texas Instruments Inc 2002, 2003, 2004, 2005, 2008
 *
 *   Use of this software is controlled by the terms and conditions found in
 *   the license agreement under which this software has been supplied.
 *  ===========================================================================
 */

/* ============================================================================
 * Revision History
 * ================
 * 05-Sept-2008 Added LCDC of CSL.
 * 06-May-2009 Removed the Raster mode support for C5505 PG1.4
 * 26-May-2009 Modified based on the review comments
 * ============================================================================
 */

#ifndef _CSL_LCD_H_
#define _CSL_LCD_H_

#ifdef __cplusplus
extern "C" {
#endif

#include <soc.h>
#include <tistdtypes.h>
#include <cslr_sysctrl.h>
#include <csl_types.h>
#include <csl_error.h>
#include <csl_general.h>

/*****************************************************************************\
          LCDC global macro declarations
\*****************************************************************************/

#define CSL_LCDC_INSTANCE_0             (0x0)

#define CSL_LCDC_INSTANCE_INV           (0xFF)

#define CSL_LCD_ENABLE                  (Uint16)(0x1)

#define CSL_LCD_DISABLE                 (Uint16)(0x0)

#define CSL_LCD_ACTIVE                  (Uint16)(0x0)

#define CSL_LCD_RESET_CLOCK_CYCLE       (0x20)

#define CSL_LCD_SARAM_START_ADDR        (0x08000)

#define CSL_LCD_SARAM_END_ADDR          (0x27FFF)

#define CSL_LCD_SARAM_DMA_ADDR_OFFSET   (0x080000)

#define CSL_LCD_UINT16_MASK             (0xFFFF)

#define CSL_LCD_DMA_SHIFT               (0x01)

#define CSL_LCD_UINT16_NUMBER_BITS      (0x0010)

#define CSL_LCD_LCDLIDDCR_POLARITY_CONTROL_MASK  (0x00F8)

/*****************************************************************************\
          LCDC global typedef declarations
\*****************************************************************************/

typedef enum {
    CSL_LCDC_LIDD_CS0, 
    CSL_LCDC_LIDD_CS1  
} CSL_LcdcChipSelect;

typedef enum {
    CSL_LCDC_LIDD_NOT_USE_CS1, 
    CSL_LCDC_LIDD_USE_CS1  
} CSL_LcdcCs1Status;

typedef enum {
    CSL_LCDC_LIDD_SYNC_MPU68 = CSL_LCDC_LCDLIDDCR_LIDD_MODE_SEL_SYNC_MPU68,
    CSL_LCDC_LIDD_ASYNC_MPU68 = CSL_LCDC_LCDLIDDCR_LIDD_MODE_SEL_ASYNC_MPU68,
    CSL_LCDC_LIDD_SYNC_MPU80 = CSL_LCDC_LCDLIDDCR_LIDD_MODE_SEL_SYNC_MPU80,
    CSL_LCDC_LIDD_ASYNC_MPU80 = CSL_LCDC_LCDLIDDCR_LIDD_MODE_SEL_ASYNC_MPU80,
    CSL_LCDC_LIDD_ASYNC_HITACHI = CSL_LCDC_LCDLIDDCR_LIDD_MODE_SEL_HITACHI
} CSL_LcdcLiddMode;

typedef enum {
    CSL_LCDC_LIDD_FDONE_DISABLE,
    CSL_LCDC_LIDD_FDONE_ENABLE
} CSL_LcdcFdoneCtl;

typedef enum {
    CSL_LCDC_LIDD_DMA_DISABLE,
    CSL_LCDC_LIDD_DMA_ENABLE
} CSL_LcdcDmaCtl;

typedef enum {
    CSL_LCDC_DMA_BURST1 = CSL_LCDC_LCDDMACR_BURST_SIZE_BSIZE1,
    CSL_LCDC_DMA_BURST2 = CSL_LCDC_LCDDMACR_BURST_SIZE_BSIZE2,
    CSL_LCDC_DMA_BURST4 = CSL_LCDC_LCDDMACR_BURST_SIZE_BSIZE4,
    CSL_LCDC_DMA_BURST8 = CSL_LCDC_LCDDMACR_BURST_SIZE_BSIZE8,
    CSL_LCDC_DMA_BURST16 = CSL_LCDC_LCDDMACR_BURST_SIZE_BSIZE16
} CSL_LcdcDmaBurst;

typedef enum {
    CSL_LCDC_SUBPANEL_DISABLE = 0,
    CSL_LCDC_SUBPANEL_ENABLE  = 1
} CSL_LcdcSubpanelCtl;

typedef enum {
    CSL_LCDC_SUBPANPOS_LOW = 0,
    CSL_LCDC_SUBPANPOS_HIGH  = 1
} CSL_LcdcSubpanPosCtl;

typedef enum {
    CSL_LCDC_SYNCCTL_PIXCLK = 0,
    CSL_LCDC_SYNCCTL_BIT24  = 1
} CSL_LcdcSyncClkCtl;

typedef enum {
    CSL_LCDC_SYNCEDGECTL_FALL = 0,
    CSL_LCDC_SYNCEDGECTL_RISE = 1
} CSL_LcdcSyncEdgeCtl;

typedef enum {
    CSL_LCDC_EOFINT_DISABLE = 0,
    CSL_LCDC_EOFINT_ENABLE = 1
} CSL_LcdcEofIntCtl;

typedef enum {
    CSL_LCDC_ENDIANESS_LITTLE = 0,
    CSL_LCDC_ENDIANESS_BIG    = 1
} CSL_LcdcEndianess;

typedef enum {
    CSL_LCDC_FBMODE_SINGLE = 0,
    CSL_LCDC_FBMODE_DOUBLE = 1
} CSL_LcdcFrameMode;

typedef struct {
    Uint16  clkDiv;
    CSL_LcdcFdoneCtl  fdoneIntEn;
    CSL_LcdcChipSelect  dmaCs0Cs1;
    CSL_LcdcDmaCtl  dmaEnable;
    CSL_BitMask16 polControl;
    CSL_LcdcLiddMode  modeSel;
} CSL_LcdcConfigLidd;

typedef struct {
    Uint16    wSu;
    Uint16    wStrobe;
    Uint16    wHold;
    Uint16    rSu;
    Uint16    rStrobe;
    Uint16    rHold;
    Uint16    ta;
} CSL_LcdcLiddTiming;

typedef struct {
    CSL_LcdcDmaBurst   burstSize;
    CSL_LcdcEofIntCtl  eofIntEn;
    CSL_LcdcEndianess  bigEndian;
    CSL_LcdcFrameMode  frameMode;
    Uint32  fb0Base;
    Uint32  fb0Ceil;
    Uint32  fb1Base;
    Uint32  fb1Ceil;
} CSL_LcdcConfigDma;

typedef struct {
    void                  *extendSetup;
    CSL_LcdcConfigLidd    config;
    CSL_LcdcLiddTiming    timingCs0;
    CSL_LcdcCs1Status     useCs1;
    CSL_LcdcLiddTiming    timingCs1;
} CSL_LcdcHwSetup;

typedef struct CSL_LcdcObj {
    CSL_LcdcRegsOvly    regs;
    CSL_InstNum         perNum;
} CSL_LcdcObj;

typedef CSL_LcdcObj*    CSL_LcdcHandle;

typedef struct {
    CSL_LcdcRegsOvly regs;
} CSL_LcdcBaseAddress;

typedef struct {
    CSL_BitMask16   flags;
} CSL_LcdcParam;

typedef struct {
    Uint16  contextInfo;
} CSL_LcdcContext;

/******************************************************************************
 * CSL LCDC function declarations
 *****************************************************************************/
CSL_Status LCD_init(void);

CSL_LcdcHandle LCD_open (
                   Uint16       instanceNum,
                   CSL_LcdcObj  *pLcdcObj,
                   CSL_Status   *status     );

CSL_Status LCD_setup (
               CSL_LcdcHandle         hLcdc,
               CSL_LcdcHwSetup*       setup  );

CSL_Status LCD_configDMA (
               CSL_LcdcHandle         hLcdc,
               CSL_LcdcConfigDma*     pconfigDma );

CSL_Status LCD_close(
               CSL_LcdcHandle     hLcdc);
#ifdef __cplusplus
}
#endif
#endif /* _CSL_LCDC_H_ */