ST / BSP_DISCO_H747I

BSP files for STM32H747I-Discovery Copy from ST Cube delivery

Dependents:   DISCO_H747I_LCD_demo DISCO_H747I_AUDIO_demo

Components/otm8009a/otm8009a.h@3:bc403474b366, 2019-11-06 (annotated)

Committer:
Jerome Coutant
Date:
Wed Nov 06 11:32:01 2019 +0100
Revision:
3:bc403474b366
Parent:
0:146cf26a9bbb 
Add PDM lib

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Jerome Coutant 0:146cf26a9bbb 1 /**
Jerome Coutant 0:146cf26a9bbb 2 ******************************************************************************
Jerome Coutant 0:146cf26a9bbb 3 * @file otm8009a.h
Jerome Coutant 0:146cf26a9bbb 4 * @author MCD Application Team
Jerome Coutant 0:146cf26a9bbb 5 * @version V1.0.2
Jerome Coutant 0:146cf26a9bbb 6 * @date 27-January-2017
Jerome Coutant 0:146cf26a9bbb 7 * @brief This file contains all the constants parameters for the OTM8009A
Jerome Coutant 0:146cf26a9bbb 8 * which is the LCD Driver for KoD KM-040TMP-02-0621 (WVGA)
Jerome Coutant 0:146cf26a9bbb 9 * DSI LCD Display.
Jerome Coutant 0:146cf26a9bbb 10 ******************************************************************************
Jerome Coutant 0:146cf26a9bbb 11 * @attention
Jerome Coutant 0:146cf26a9bbb 12 *
Jerome Coutant 0:146cf26a9bbb 13 * <h2><center>&copy; COPYRIGHT(c) 2017 STMicroelectronics</center></h2>
Jerome Coutant 0:146cf26a9bbb 14 *
Jerome Coutant 0:146cf26a9bbb 15 * Redistribution and use in source and binary forms, with or without modification,
Jerome Coutant 0:146cf26a9bbb 16 * are permitted provided that the following conditions are met:
Jerome Coutant 0:146cf26a9bbb 17 * 1. Redistributions of source code must retain the above copyright notice,
Jerome Coutant 0:146cf26a9bbb 18 * this list of conditions and the following disclaimer.
Jerome Coutant 0:146cf26a9bbb 19 * 2. Redistributions in binary form must reproduce the above copyright notice,
Jerome Coutant 0:146cf26a9bbb 20 * this list of conditions and the following disclaimer in the documentation
Jerome Coutant 0:146cf26a9bbb 21 * and/or other materials provided with the distribution.
Jerome Coutant 0:146cf26a9bbb 22 * 3. Neither the name of STMicroelectronics nor the names of its contributors
Jerome Coutant 0:146cf26a9bbb 23 * may be used to endorse or promote products derived from this software
Jerome Coutant 0:146cf26a9bbb 24 * without specific prior written permission.
Jerome Coutant 0:146cf26a9bbb 25 *
Jerome Coutant 0:146cf26a9bbb 26 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
Jerome Coutant 0:146cf26a9bbb 27 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
Jerome Coutant 0:146cf26a9bbb 28 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
Jerome Coutant 0:146cf26a9bbb 29 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
Jerome Coutant 0:146cf26a9bbb 30 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
Jerome Coutant 0:146cf26a9bbb 31 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
Jerome Coutant 0:146cf26a9bbb 32 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
Jerome Coutant 0:146cf26a9bbb 33 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
Jerome Coutant 0:146cf26a9bbb 34 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
Jerome Coutant 0:146cf26a9bbb 35 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Jerome Coutant 0:146cf26a9bbb 36 *
Jerome Coutant 0:146cf26a9bbb 37 ******************************************************************************
Jerome Coutant 0:146cf26a9bbb 38 */
Jerome Coutant 0:146cf26a9bbb 39
Jerome Coutant 0:146cf26a9bbb 40 /* Define to prevent recursive inclusion -------------------------------------*/
Jerome Coutant 0:146cf26a9bbb 41 #ifndef __OTM8009A_H
Jerome Coutant 0:146cf26a9bbb 42 #define __OTM8009A_H
Jerome Coutant 0:146cf26a9bbb 43
Jerome Coutant 0:146cf26a9bbb 44 #ifdef __cplusplus
Jerome Coutant 0:146cf26a9bbb 45 extern "C" {
Jerome Coutant 0:146cf26a9bbb 46 #endif
Jerome Coutant 0:146cf26a9bbb 47
Jerome Coutant 0:146cf26a9bbb 48 /* Includes ------------------------------------------------------------------*/
Jerome Coutant 0:146cf26a9bbb 49 #include <stdint.h>
Jerome Coutant 0:146cf26a9bbb 50 /** @addtogroup BSP
Jerome Coutant 0:146cf26a9bbb 51 * @{
Jerome Coutant 0:146cf26a9bbb 52 */
Jerome Coutant 0:146cf26a9bbb 53
Jerome Coutant 0:146cf26a9bbb 54 /** @addtogroup Components
Jerome Coutant 0:146cf26a9bbb 55 * @{
Jerome Coutant 0:146cf26a9bbb 56 */
Jerome Coutant 0:146cf26a9bbb 57
Jerome Coutant 0:146cf26a9bbb 58 /** @addtogroup otm8009a
Jerome Coutant 0:146cf26a9bbb 59 * @{
Jerome Coutant 0:146cf26a9bbb 60 */
Jerome Coutant 0:146cf26a9bbb 61
Jerome Coutant 0:146cf26a9bbb 62 /** @addtogroup OTM8009A_Exported_Variables
Jerome Coutant 0:146cf26a9bbb 63 * @{
Jerome Coutant 0:146cf26a9bbb 64 */
Jerome Coutant 0:146cf26a9bbb 65
Jerome Coutant 0:146cf26a9bbb 66 #if defined ( __GNUC__ )
Jerome Coutant 0:146cf26a9bbb 67 #ifndef __weak
Jerome Coutant 0:146cf26a9bbb 68 #define __weak __attribute__((weak))
Jerome Coutant 0:146cf26a9bbb 69 #endif /* __weak */
Jerome Coutant 0:146cf26a9bbb 70 #endif /* __GNUC__ */
Jerome Coutant 0:146cf26a9bbb 71
Jerome Coutant 0:146cf26a9bbb 72 /**
Jerome Coutant 0:146cf26a9bbb 73 * @brief LCD_OrientationTypeDef
Jerome Coutant 0:146cf26a9bbb 74 * Possible values of Display Orientation
Jerome Coutant 0:146cf26a9bbb 75 */
Jerome Coutant 0:146cf26a9bbb 76 #define OTM8009A_ORIENTATION_PORTRAIT ((uint32_t)0x00) /* Portrait orientation choice of LCD screen */
Jerome Coutant 0:146cf26a9bbb 77 #define OTM8009A_ORIENTATION_LANDSCAPE ((uint32_t)0x01) /* Landscape orientation choice of LCD screen */
Jerome Coutant 0:146cf26a9bbb 78
Jerome Coutant 0:146cf26a9bbb 79 /**
Jerome Coutant 0:146cf26a9bbb 80 * @brief Possible values of
Jerome Coutant 0:146cf26a9bbb 81 * pixel data format (ie color coding) transmitted on DSI Data lane in DSI packets
Jerome Coutant 0:146cf26a9bbb 82 */
Jerome Coutant 0:146cf26a9bbb 83 #define OTM8009A_FORMAT_RGB888 ((uint32_t)0x00) /* Pixel format chosen is RGB888 : 24 bpp */
Jerome Coutant 0:146cf26a9bbb 84 #define OTM8009A_FORMAT_RBG565 ((uint32_t)0x02) /* Pixel format chosen is RGB565 : 16 bpp */
Jerome Coutant 0:146cf26a9bbb 85
Jerome Coutant 0:146cf26a9bbb 86 /**
Jerome Coutant 0:146cf26a9bbb 87 * @brief otm8009a_480x800 Size
Jerome Coutant 0:146cf26a9bbb 88 */
Jerome Coutant 0:146cf26a9bbb 89
Jerome Coutant 0:146cf26a9bbb 90 /* Width and Height in Portrait mode */
Jerome Coutant 0:146cf26a9bbb 91 #define OTM8009A_480X800_WIDTH ((uint16_t)480) /* LCD PIXEL WIDTH */
Jerome Coutant 0:146cf26a9bbb 92 #define OTM8009A_480X800_HEIGHT ((uint16_t)800) /* LCD PIXEL HEIGHT */
Jerome Coutant 0:146cf26a9bbb 93
Jerome Coutant 0:146cf26a9bbb 94 /* Width and Height in Landscape mode */
Jerome Coutant 0:146cf26a9bbb 95 #define OTM8009A_800X480_WIDTH ((uint16_t)800) /* LCD PIXEL WIDTH */
Jerome Coutant 0:146cf26a9bbb 96 #define OTM8009A_800X480_HEIGHT ((uint16_t)480) /* LCD PIXEL HEIGHT */
Jerome Coutant 0:146cf26a9bbb 97
Jerome Coutant 0:146cf26a9bbb 98 /**
Jerome Coutant 0:146cf26a9bbb 99 * @brief OTM8009A_480X800 Timing parameters for Portrait orientation mode
Jerome Coutant 0:146cf26a9bbb 100 */
Jerome Coutant 0:146cf26a9bbb 101 #define OTM8009A_480X800_HSYNC ((uint16_t)2) /* Horizontal synchronization */
Jerome Coutant 0:146cf26a9bbb 102 #define OTM8009A_480X800_HBP ((uint16_t)34) /* Horizontal back porch */
Jerome Coutant 0:146cf26a9bbb 103 #define OTM8009A_480X800_HFP ((uint16_t)34) /* Horizontal front porch */
Jerome Coutant 0:146cf26a9bbb 104 #define OTM8009A_480X800_VSYNC ((uint16_t)1) /* Vertical synchronization */
Jerome Coutant 0:146cf26a9bbb 105 #define OTM8009A_480X800_VBP ((uint16_t)15) /* Vertical back porch */
Jerome Coutant 0:146cf26a9bbb 106 #define OTM8009A_480X800_VFP ((uint16_t)16) /* Vertical front porch */
Jerome Coutant 0:146cf26a9bbb 107
Jerome Coutant 0:146cf26a9bbb 108 /**
Jerome Coutant 0:146cf26a9bbb 109 * @brief OTM8009A_800X480 Timing parameters for Landscape orientation mode
Jerome Coutant 0:146cf26a9bbb 110 * Same values as for Portrait mode in fact.
Jerome Coutant 0:146cf26a9bbb 111 */
Jerome Coutant 0:146cf26a9bbb 112 #define OTM8009A_800X480_HSYNC OTM8009A_480X800_VSYNC /* Horizontal synchronization */
Jerome Coutant 0:146cf26a9bbb 113 #define OTM8009A_800X480_HBP OTM8009A_480X800_VBP /* Horizontal back porch */
Jerome Coutant 0:146cf26a9bbb 114 #define OTM8009A_800X480_HFP OTM8009A_480X800_VFP /* Horizontal front porch */
Jerome Coutant 0:146cf26a9bbb 115 #define OTM8009A_800X480_VSYNC OTM8009A_480X800_HSYNC /* Vertical synchronization */
Jerome Coutant 0:146cf26a9bbb 116 #define OTM8009A_800X480_VBP OTM8009A_480X800_HBP /* Vertical back porch */
Jerome Coutant 0:146cf26a9bbb 117 #define OTM8009A_800X480_VFP OTM8009A_480X800_HFP /* Vertical front porch */
Jerome Coutant 0:146cf26a9bbb 118
Jerome Coutant 0:146cf26a9bbb 119
Jerome Coutant 0:146cf26a9bbb 120 /* List of OTM8009A used commands */
Jerome Coutant 0:146cf26a9bbb 121 /* Detailed in OTM8009A Data Sheet 'DATA_SHEET_OTM8009A_V0 92.pdf' */
Jerome Coutant 0:146cf26a9bbb 122 /* Version of 14 June 2012 */
Jerome Coutant 0:146cf26a9bbb 123 #define OTM8009A_CMD_NOP 0x00 /* NOP command */
Jerome Coutant 0:146cf26a9bbb 124 #define OTM8009A_CMD_SWRESET 0x01 /* Sw reset command */
Jerome Coutant 0:146cf26a9bbb 125 #define OTM8009A_CMD_RDDMADCTL 0x0B /* Read Display MADCTR command : read memory display access ctrl */
Jerome Coutant 0:146cf26a9bbb 126 #define OTM8009A_CMD_RDDCOLMOD 0x0C /* Read Display pixel format */
Jerome Coutant 0:146cf26a9bbb 127 #define OTM8009A_CMD_SLPIN 0x10 /* Sleep In command */
Jerome Coutant 0:146cf26a9bbb 128 #define OTM8009A_CMD_SLPOUT 0x11 /* Sleep Out command */
Jerome Coutant 0:146cf26a9bbb 129 #define OTM8009A_CMD_PTLON 0x12 /* Partial mode On command */
Jerome Coutant 0:146cf26a9bbb 130
Jerome Coutant 0:146cf26a9bbb 131 #define OTM8009A_CMD_DISPOFF 0x28 /* Display Off command */
Jerome Coutant 0:146cf26a9bbb 132 #define OTM8009A_CMD_DISPON 0x29 /* Display On command */
Jerome Coutant 0:146cf26a9bbb 133
Jerome Coutant 0:146cf26a9bbb 134 #define OTM8009A_CMD_CASET 0x2A /* Column address set command */
Jerome Coutant 0:146cf26a9bbb 135 #define OTM8009A_CMD_PASET 0x2B /* Page address set command */
Jerome Coutant 0:146cf26a9bbb 136
Jerome Coutant 0:146cf26a9bbb 137 #define OTM8009A_CMD_RAMWR 0x2C /* Memory (GRAM) write command */
Jerome Coutant 0:146cf26a9bbb 138 #define OTM8009A_CMD_RAMRD 0x2E /* Memory (GRAM) read command */
Jerome Coutant 0:146cf26a9bbb 139
Jerome Coutant 0:146cf26a9bbb 140 #define OTM8009A_CMD_PLTAR 0x30 /* Partial area command (4 parameters) */
Jerome Coutant 0:146cf26a9bbb 141
Jerome Coutant 0:146cf26a9bbb 142 #define OTM8009A_CMD_TEOFF 0x34 /* Tearing Effect Line Off command : command with no parameter */
Jerome Coutant 0:146cf26a9bbb 143
Jerome Coutant 0:146cf26a9bbb 144 #define OTM8009A_CMD_TEEON 0x35 /* Tearing Effect Line On command : command with 1 parameter 'TELOM' */
Jerome Coutant 0:146cf26a9bbb 145
Jerome Coutant 0:146cf26a9bbb 146 /* Parameter TELOM : Tearing Effect Line Output Mode : possible values */
Jerome Coutant 0:146cf26a9bbb 147 #define OTM8009A_TEEON_TELOM_VBLANKING_INFO_ONLY 0x00
Jerome Coutant 0:146cf26a9bbb 148 #define OTM8009A_TEEON_TELOM_VBLANKING_AND_HBLANKING_INFO 0x01
Jerome Coutant 0:146cf26a9bbb 149
Jerome Coutant 0:146cf26a9bbb 150 #define OTM8009A_CMD_MADCTR 0x36 /* Memory Access write control command */
Jerome Coutant 0:146cf26a9bbb 151
Jerome Coutant 0:146cf26a9bbb 152 /* Possible used values of MADCTR */
Jerome Coutant 0:146cf26a9bbb 153 #define OTM8009A_MADCTR_MODE_PORTRAIT 0x00
Jerome Coutant 0:146cf26a9bbb 154 #define OTM8009A_MADCTR_MODE_LANDSCAPE 0x60 /* MY = 0, MX = 1, MV = 1, ML = 0, RGB = 0 */
Jerome Coutant 0:146cf26a9bbb 155
Jerome Coutant 0:146cf26a9bbb 156 #define OTM8009A_CMD_IDMOFF 0x38 /* Idle mode Off command */
Jerome Coutant 0:146cf26a9bbb 157 #define OTM8009A_CMD_IDMON 0x39 /* Idle mode On command */
Jerome Coutant 0:146cf26a9bbb 158
Jerome Coutant 0:146cf26a9bbb 159 #define OTM8009A_CMD_COLMOD 0x3A /* Interface Pixel format command */
Jerome Coutant 0:146cf26a9bbb 160
Jerome Coutant 0:146cf26a9bbb 161 /* Possible values of COLMOD parameter corresponding to used pixel formats */
Jerome Coutant 0:146cf26a9bbb 162 #define OTM8009A_COLMOD_RGB565 0x55
Jerome Coutant 0:146cf26a9bbb 163 #define OTM8009A_COLMOD_RGB888 0x77
Jerome Coutant 0:146cf26a9bbb 164
Jerome Coutant 0:146cf26a9bbb 165 #define OTM8009A_CMD_RAMWRC 0x3C /* Memory write continue command */
Jerome Coutant 0:146cf26a9bbb 166 #define OTM8009A_CMD_RAMRDC 0x3E /* Memory read continue command */
Jerome Coutant 0:146cf26a9bbb 167
Jerome Coutant 0:146cf26a9bbb 168 #define OTM8009A_CMD_WRTESCN 0x44 /* Write Tearing Effect Scan line command */
Jerome Coutant 0:146cf26a9bbb 169 #define OTM8009A_CMD_RDSCNL 0x45 /* Read Tearing Effect Scan line command */
Jerome Coutant 0:146cf26a9bbb 170
Jerome Coutant 0:146cf26a9bbb 171 /* CABC Management : ie : Content Adaptive Back light Control in IC OTM8009a */
Jerome Coutant 0:146cf26a9bbb 172 #define OTM8009A_CMD_WRDISBV 0x51 /* Write Display Brightness command */
Jerome Coutant 0:146cf26a9bbb 173 #define OTM8009A_CMD_WRCTRLD 0x53 /* Write CTRL Display command */
Jerome Coutant 0:146cf26a9bbb 174 #define OTM8009A_CMD_WRCABC 0x55 /* Write Content Adaptive Brightness command */
Jerome Coutant 0:146cf26a9bbb 175 #define OTM8009A_CMD_WRCABCMB 0x5E /* Write CABC Minimum Brightness command */
Jerome Coutant 0:146cf26a9bbb 176
Jerome Coutant 0:146cf26a9bbb 177 /**
Jerome Coutant 0:146cf26a9bbb 178 * @brief OTM8009A_480X800 frequency divider
Jerome Coutant 0:146cf26a9bbb 179 */
Jerome Coutant 0:146cf26a9bbb 180 #define OTM8009A_480X800_FREQUENCY_DIVIDER 2 /* LCD Frequency divider */
Jerome Coutant 0:146cf26a9bbb 181
Jerome Coutant 0:146cf26a9bbb 182 /**
Jerome Coutant 0:146cf26a9bbb 183 * @}
Jerome Coutant 0:146cf26a9bbb 184 */
Jerome Coutant 0:146cf26a9bbb 185
Jerome Coutant 0:146cf26a9bbb 186 /* Exported macro ------------------------------------------------------------*/
Jerome Coutant 0:146cf26a9bbb 187
Jerome Coutant 0:146cf26a9bbb 188 /** @defgroup OTM8009A_Exported_Macros OTM8009A Exported Macros
Jerome Coutant 0:146cf26a9bbb 189 * @{
Jerome Coutant 0:146cf26a9bbb 190 */
Jerome Coutant 0:146cf26a9bbb 191
Jerome Coutant 0:146cf26a9bbb 192 /**
Jerome Coutant 0:146cf26a9bbb 193 * @}
Jerome Coutant 0:146cf26a9bbb 194 */
Jerome Coutant 0:146cf26a9bbb 195
Jerome Coutant 0:146cf26a9bbb 196 /* Exported functions --------------------------------------------------------*/
Jerome Coutant 0:146cf26a9bbb 197
Jerome Coutant 0:146cf26a9bbb 198 /** @addtogroup OTM8009A_Exported_Functions
Jerome Coutant 0:146cf26a9bbb 199 * @{
Jerome Coutant 0:146cf26a9bbb 200 */
Jerome Coutant 0:146cf26a9bbb 201 void DSI_IO_WriteCmd(uint32_t NbrParams, uint8_t *pParams);
Jerome Coutant 0:146cf26a9bbb 202 uint8_t OTM8009A_Init(uint32_t ColorCoding, uint32_t orientation);
Jerome Coutant 0:146cf26a9bbb 203 void OTM8009A_IO_Delay(uint32_t Delay);
Jerome Coutant 0:146cf26a9bbb 204 /**
Jerome Coutant 0:146cf26a9bbb 205 * @}
Jerome Coutant 0:146cf26a9bbb 206 */
Jerome Coutant 0:146cf26a9bbb 207 #ifdef __cplusplus
Jerome Coutant 0:146cf26a9bbb 208 }
Jerome Coutant 0:146cf26a9bbb 209 #endif
Jerome Coutant 0:146cf26a9bbb 210
Jerome Coutant 0:146cf26a9bbb 211 #endif /* __OTM8009A_480X800_H */
Jerome Coutant 0:146cf26a9bbb 212 /**
Jerome Coutant 0:146cf26a9bbb 213 * @}
Jerome Coutant 0:146cf26a9bbb 214 */
Jerome Coutant 0:146cf26a9bbb 215
Jerome Coutant 0:146cf26a9bbb 216 /**
Jerome Coutant 0:146cf26a9bbb 217 * @}
Jerome Coutant 0:146cf26a9bbb 218 */
Jerome Coutant 0:146cf26a9bbb 219
Jerome Coutant 0:146cf26a9bbb 220 /**
Jerome Coutant 0:146cf26a9bbb 221 * @}
Jerome Coutant 0:146cf26a9bbb 222 */
Jerome Coutant 0:146cf26a9bbb 223
Jerome Coutant 0:146cf26a9bbb 224 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/