drv_gfx_disp_intf.h

Go to the documentation of this file.

/*******************************************************************************
* Copyright (C) 2020 Microchip Technology Inc. and its subsidiaries.
*
* Subject to your compliance with these terms, you may use Microchip software
* and any derivatives exclusively with Microchip products. It is your
* responsibility to comply with third party license terms applicable to your
* use of third party software (including open source software) that may
* accompany Microchip software.
*
* THIS SOFTWARE IS SUPPLIED BY MICROCHIP "AS IS". NO WARRANTIES, WHETHER
* EXPRESS, IMPLIED OR STATUTORY, APPLY TO THIS SOFTWARE, INCLUDING ANY IMPLIED
* WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY, AND FITNESS FOR A
* PARTICULAR PURPOSE.
*
* IN NO EVENT WILL MICROCHIP BE LIABLE FOR ANY INDIRECT, SPECIAL, PUNITIVE,
* INCIDENTAL OR CONSEQUENTIAL LOSS, DAMAGE, COST OR EXPENSE OF ANY KIND
* WHATSOEVER RELATED TO THE SOFTWARE, HOWEVER CAUSED, EVEN IF MICROCHIP HAS
* BEEN ADVISED OF THE POSSIBILITY OR THE DAMAGES ARE FORESEEABLE. TO THE
* FULLEST EXTENT ALLOWED BY LAW, MICROCHIP'S TOTAL LIABILITY ON ALL CLAIMS IN
* ANY WAY RELATED TO THIS SOFTWARE WILL NOT EXCEED THE AMOUNT OF FEES, IF ANY,
* THAT YOU HAVE PAID DIRECTLY TO MICROCHIP FOR THIS SOFTWARE.
*******************************************************************************/

/*******************************************************************************
 Module for Microchip Graphics Library - Hardware Abstraction Layer

  Company:
    Microchip Technology Inc.

  File Name:
    drv_gfx_intf.h

  Summary:
    Contains 4-line SPI GFX interface driver definitions and interface prototypes.

  Description:
    Contains 4-line SPI GFX interface driver definitions and interface prototypes.
*******************************************************************************/

#ifndef _DRV_GFX_DISP_INTF_H    /* Guard against multiple inclusion */
#define _DRV_GFX_DISP_INTF_H

/* ************************************************************************** */
/* ************************************************************************** */
/* Section: Included Files                                                    */
/* ************************************************************************** */
/* ************************************************************************** */

#define GFX_Disp_Intf    uint32_t

#define DRV_GFX_DEPRECATED __attribute__ ((deprecated))

typedef enum
{
    GFX_DISP_INTF_TX_DONE,       //Transfer Done
    GFX_DISP_INTF_ERROR,        //Error
} GFX_DISP_INTF_STATUS;

typedef enum
{
    GFX_DISP_INTF_PIN_CS,        //Chip Select
    GFX_DISP_INTF_PIN_WR,        //Write Strobe
    GFX_DISP_INTF_PIN_RD,        //Read Strobe
    GFX_DISP_INTF_PIN_RSDC,      //Register Select or Data/Command
} GFX_DISP_INTF_PIN;

typedef enum
{
    GFX_DISP_INTF_PIN_CLEAR = 0,
    GFX_DISP_INTF_PIN_SET = 1,
} GFX_DISP_INTF_PIN_VALUE;

typedef void (*GFX_Disp_Intf_Callback)(GFX_Disp_Intf,
                                       GFX_DISP_INTF_STATUS, 
                                       void *);

/* Provide C++ Compatibility */
#ifdef __cplusplus
extern "C" {
#endif

GFX_Disp_Intf GFX_Disp_Intf_Open(void);

void GFX_Disp_Intf_Close(GFX_Disp_Intf intf);

int GFX_Disp_Intf_PinControl(GFX_Disp_Intf intf, GFX_DISP_INTF_PIN pin, GFX_DISP_INTF_PIN_VALUE value);

int GFX_Disp_Intf_WriteCommand(GFX_Disp_Intf intf, uint8_t cmd);

int GFX_Disp_Intf_WriteCommandParm(GFX_Disp_Intf intf, uint8_t cmd, uint8_t * parm, int num_parms);

int GFX_Disp_Intf_WriteData(GFX_Disp_Intf intf, uint8_t * data, int bytes);

int GFX_Disp_Intf_WriteData16(GFX_Disp_Intf intf, uint16_t * data, int num);

int GFX_Disp_Intf_ReadData(GFX_Disp_Intf intf, uint8_t * data, int bytes);

int GFX_Disp_Intf_ReadCommandData(GFX_Disp_Intf intf, uint8_t cmd, uint8_t * data, int num_data);

int GFX_Disp_Intf_ReadData16(GFX_Disp_Intf intf, uint16_t * data, int num);

int GFX_Disp_Intf_Write(GFX_Disp_Intf intf, uint8_t * data, int bytes);

int GFX_Disp_Intf_Read(GFX_Disp_Intf intf, uint8_t * data, int bytes);

int GFX_Disp_Intf_WriteDataByte(GFX_Disp_Intf intf, uint8_t data);

int GFX_Disp_Intf_Ready(GFX_Disp_Intf intf);

int GFX_Disp_Intf_Set_Callback(GFX_Disp_Intf intf, GFX_Disp_Intf_Callback cb, void * parm);


    /* Provide C++ Compatibility */
#ifdef __cplusplus
}
#endif

#endif /* _DRV_GFX_DISP_INTF_H */

/* *****************************************************************************
 End of File
 */