packages/ti/board/diag/oled_display/src/oled_test.h

   1 /*
   2  * Copyright (c) 2016-2020, Texas Instruments Incorporated
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  *
   9  * *  Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  *
  12  * *  Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * *  Neither the name of Texas Instruments Incorporated nor the names of
  17  *    its contributors may be used to endorse or promote products derived
  18  *    from this software without specific prior written permission.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  21  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  22  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  23  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
  24  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  25  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  26  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
  27  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  28  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  29  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
  30  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  31  *
  32  */
  33
  34 /**
  35  *
  36  * \file  oled_test.h
  37  *
  38  * \brief   This file contains structure, typedefs, functions and
  39  *          prototypes used for oled test
  40  *
  41  *****************************************************************************/
  42
  43 #ifndef _OLED_TEST_H_
  44 #define _OLED_TEST_H_
  45
  46 #include <stdio.h>
  47 #include <stdlib.h>
  48 #include <string.h>
  49
  50 #if !defined(SOC_AM64X)
  51 #include <ti/drv/gpio/GPIO.h>
  52 #include <ti/drv/gpio/soc/GPIO_soc.h>
  53 #endif
  54
  55 #include <ti/drv/i2c/I2C.h>
  56 #include <ti/drv/i2c/soc/I2C_soc.h>
  57 #include <ti/drv/uart/UART_stdio.h>
  58
  59 #if defined(SOC_K2G) || defined(SOC_AM64X)
  60 #include "diag_common_cfg.h"
  61 #endif
  62
  63 #include "board.h"
  64 #include "board_cfg.h"
  65 #include "oled_display.h"
  66
  67 #if defined(SOC_AM64X)
  68 #include <ti/drv/i2c/I2C.h>
  69 #include <ti/drv/i2c/soc/I2C_soc.h>
  70 #include "board_internal.h"
  71 #include "board_i2c_io_exp.h"
  72
  73 /* Platform test return codes */
  74 #define TEST_PASS     (0)
  75 #define TEST_FAIL     (-1)
  76
  77 #endif
  78
  79 #if !defined(SOC_AM64X)
  80 /* GPIO pin value definitions */
  81 #define GPIO_PIN_VAL_LOW     (0U)
  82 #define GPIO_PIN_VAL_HIGH    (1U)
  83
  84 #define GPIO_INDEX           (0U)
  85
  86 /* Port and pin number mask for LCD GPIO.
  87    Bits 7-0: Pin number  and Bits 15-8: Port number */
  88 #define LCD_BST_CONV_CTL_GPIO    0x002D
  89 #define LCD_RESET                0x0134
  90 #endif
  91
  92
  93 #if defined(SOC_AM64X)
  94 /* Platform test return type */
  95 typedef int16_t TEST_STATUS;
  96 #endif
  97
  98 /**
  99  * \brief This function performs oled test
 100  *
 101  * \param void
 102  *
 103  * \return
 104  * \n      TEST_PASS  - Test Passed
 105  * \n      TEST_FAIL  - Test Failed
 106  *
 107  */
 108 TEST_STATUS oledTest(void);
 109
 110 #endif // _OLED_TEST_H_
 111
 112 /* Nothing past this point */