Stepan Smejkal / UniGraphic

.

Protocols/Protocols.h@25:daacdcf34e52, 2015-10-18 (annotated)

Committer:
dreschpe
Date:
Sun Oct 18 13:53:20 2015 +0000
Revision:
25:daacdcf34e52
Parent:
21:ae0a4eedfc90
Child:
30:87855d03d91a
Add check if platform supports par port mode

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Geremia 4:12ba0ecc2c1f 1 /* mbed UniGraphic library - Abstract protocol class
Geremia 4:12ba0ecc2c1f 2 * Copyright (c) 2015 Giuliano Dianda
Geremia 4:12ba0ecc2c1f 3 * Released under the MIT License: http://mbed.org/license/mit
Geremia 4:12ba0ecc2c1f 4 */
Geremia 4:12ba0ecc2c1f 5
Geremia 0:75ec1b3cde17 6 /** @file Protocols.h
Geremia 0:75ec1b3cde17 7 */
Geremia 0:75ec1b3cde17 8 #ifndef Protocols_H
Geremia 0:75ec1b3cde17 9 #define Protocols_H
Geremia 0:75ec1b3cde17 10
Geremia 0:75ec1b3cde17 11 #include "mbed.h"
Geremia 0:75ec1b3cde17 12
Geremia 11:b842b8e332cb 13 #define RGB24to16(r,g,b) (((r&0xF8)<<8)|((g&0xFC)<<3)|((b&0xF8)>>3)) //5 red | 6 green | 5 blue
Geremia 5:b222a9461d6b 14 #define BGR2RGB(color) (((color&0x1F)<<11) | (color&0x7E0) | ((color&0xF800)>>11))
Geremia 5:b222a9461d6b 15
Geremia 3:48f3282c2be8 16 //#define USE_CS
Geremia 3:48f3282c2be8 17
Geremia 0:75ec1b3cde17 18 /** Protocol types
Geremia 0:75ec1b3cde17 19 */
dreschpe 25:daacdcf34e52 20 #include "platform.h"
dreschpe 25:daacdcf34e52 21
dreschpe 25:daacdcf34e52 22 #if DEVICE_PORTINOUT
Geremia 0:75ec1b3cde17 23 enum proto_t {
Geremia 21:ae0a4eedfc90 24 PAR_8 /**< Parallel 8bit, port pins 0 to 7 */
Geremia 21:ae0a4eedfc90 25 ,PAR_16 /**< Parallel 16bit, port pins 0 to 15 */
Geremia 21:ae0a4eedfc90 26 ,BUS_8 /**< Parallel 8bit, scattered pins */
Geremia 21:ae0a4eedfc90 27 ,BUS_16 /**< Parallel 16bit, scattered pins */
Geremia 0:75ec1b3cde17 28 ,SPI_8 /**< SPI 8bit */
Geremia 0:75ec1b3cde17 29 ,SPI_16 /**< SPI 16bit */
Geremia 0:75ec1b3cde17 30 };
dreschpe 25:daacdcf34e52 31 #else
dreschpe 25:daacdcf34e52 32 enum proto_t {
dreschpe 25:daacdcf34e52 33 BUS_8 /**< Parallel 8bit, scattered pins */
dreschpe 25:daacdcf34e52 34 ,BUS_16 /**< Parallel 16bit, scattered pins */
dreschpe 25:daacdcf34e52 35 ,SPI_8 /**< SPI 8bit */
dreschpe 25:daacdcf34e52 36 ,SPI_16 /**< SPI 16bit */
dreschpe 25:daacdcf34e52 37 };
dreschpe 25:daacdcf34e52 38 #endif
Geremia 0:75ec1b3cde17 39
Geremia 0:75ec1b3cde17 40
Geremia 6:8356d48a07db 41 /** Abstract interface class for spi and parallel protocols
Geremia 0:75ec1b3cde17 42 */
Geremia 0:75ec1b3cde17 43 class Protocols
Geremia 0:75ec1b3cde17 44 {
Geremia 0:75ec1b3cde17 45 public:
Geremia 0:75ec1b3cde17 46
Geremia 1:ff019d22b275 47 /** Send 8bit command to display controller
Geremia 0:75ec1b3cde17 48 *
Geremia 0:75ec1b3cde17 49 * @param cmd: byte to send
Geremia 0:75ec1b3cde17 50 *
Geremia 0:75ec1b3cde17 51 */
Geremia 1:ff019d22b275 52 virtual void wr_cmd8(unsigned char cmd) = 0;
Geremia 0:75ec1b3cde17 53
Geremia 1:ff019d22b275 54 /** Send 8bit data to display controller
Geremia 0:75ec1b3cde17 55 *
Geremia 1:ff019d22b275 56 * @param data: byte to send
Geremia 0:75ec1b3cde17 57 *
Geremia 0:75ec1b3cde17 58 */
Geremia 1:ff019d22b275 59 virtual void wr_data8(unsigned char data) = 0;
Geremia 0:75ec1b3cde17 60
Geremia 4:12ba0ecc2c1f 61 /** Send 2x8bit command to display controller
Geremia 1:ff019d22b275 62 *
Geremia 1:ff019d22b275 63 * @param cmd: halfword to send
Geremia 1:ff019d22b275 64 *
Geremia 1:ff019d22b275 65 */
Geremia 1:ff019d22b275 66 virtual void wr_cmd16(unsigned short cmd) = 0;
Geremia 1:ff019d22b275 67
Geremia 4:12ba0ecc2c1f 68 /** Send 2x8bit data to display controller
Geremia 1:ff019d22b275 69 *
Geremia 1:ff019d22b275 70 * @param data: halfword to send
Geremia 0:75ec1b3cde17 71 *
Geremia 0:75ec1b3cde17 72 */
Geremia 1:ff019d22b275 73 virtual void wr_data16(unsigned short data) = 0;
Geremia 1:ff019d22b275 74
Geremia 4:12ba0ecc2c1f 75 /** Send 16bit pixeldata to display controller
Geremia 4:12ba0ecc2c1f 76 *
Geremia 4:12ba0ecc2c1f 77 * @param data: halfword to send
Geremia 4:12ba0ecc2c1f 78 *
Geremia 4:12ba0ecc2c1f 79 */
Geremia 4:12ba0ecc2c1f 80 virtual void wr_gram(unsigned short data) = 0;
Geremia 4:12ba0ecc2c1f 81
Geremia 4:12ba0ecc2c1f 82 /** Send same 16bit pixeldata to display controller multiple times
Geremia 1:ff019d22b275 83 *
Geremia 1:ff019d22b275 84 * @param data: halfword to send
Geremia 1:ff019d22b275 85 * @param count: how many
Geremia 1:ff019d22b275 86 *
Geremia 1:ff019d22b275 87 */
Geremia 4:12ba0ecc2c1f 88 virtual void wr_gram(unsigned short data, unsigned int count) = 0;
Geremia 1:ff019d22b275 89
Geremia 4:12ba0ecc2c1f 90 /** Send array of pixeldata shorts to display controller
Geremia 1:ff019d22b275 91 *
Geremia 4:12ba0ecc2c1f 92 * @param data: unsigned short pixeldata array
Geremia 1:ff019d22b275 93 * @param lenght: lenght (in shorts)
Geremia 1:ff019d22b275 94 *
Geremia 1:ff019d22b275 95 */
Geremia 4:12ba0ecc2c1f 96 virtual void wr_grambuf(unsigned short* data, unsigned int lenght) = 0;
Geremia 0:75ec1b3cde17 97
Geremia 5:b222a9461d6b 98 /** Read 16bit pixeldata from display controller (with dummy cycle)
Geremia 5:b222a9461d6b 99 *
Geremia 11:b842b8e332cb 100 * @param convert true/false. Convert 18bit to 16bit, some controllers returns 18bit
Geremia 5:b222a9461d6b 101 * @returns 16bit color
Geremia 5:b222a9461d6b 102 */
Geremia 11:b842b8e332cb 103 virtual unsigned short rd_gram(bool convert) = 0;
Geremia 5:b222a9461d6b 104
Geremia 7:bb0383b91104 105 /** Read 4x8bit register data (with dummy cycle)
Geremia 7:bb0383b91104 106 * @param reg the register to read
Geremia 7:bb0383b91104 107 * @returns data as uint
Geremia 7:bb0383b91104 108 *
Geremia 7:bb0383b91104 109 */
Geremia 7:bb0383b91104 110 virtual unsigned int rd_reg_data32(unsigned char reg) = 0;
Geremia 7:bb0383b91104 111
Geremia 7:bb0383b91104 112 /** Read 3x8bit ExtendedCommands register data
Geremia 7:bb0383b91104 113 * @param reg the register to read
Geremia 7:bb0383b91104 114 * @param SPIreadenablecmd vendor/device specific cmd to read EXTC registers
Geremia 7:bb0383b91104 115 * @returns data as uint
Geremia 7:bb0383b91104 116 * @note EXTC regs (0xB0 to 0xFF) are read/write registers but needs special cmd to be read in SPI mode
Geremia 7:bb0383b91104 117 */
Geremia 7:bb0383b91104 118 virtual unsigned int rd_extcreg_data32(unsigned char reg, unsigned char SPIreadenablecmd) = 0;
Geremia 7:bb0383b91104 119
Geremia 20:14daa48ffd4c 120 /** ILI932x specific, does a dummy read cycle, number of bits is protocol dependent
Geremia 20:14daa48ffd4c 121 * for PAR protocols: a signle RD bit toggle
Geremia 20:14daa48ffd4c 122 * for SPI8: 8clocks
Geremia 20:14daa48ffd4c 123 * for SPI16: 16 clocks
Geremia 20:14daa48ffd4c 124 */
Geremia 20:14daa48ffd4c 125 virtual void dummyread () = 0;
Geremia 20:14daa48ffd4c 126
Geremia 20:14daa48ffd4c 127 /** ILI932x specific, select register for a successive write or read
Geremia 20:14daa48ffd4c 128 *
Geremia 20:14daa48ffd4c 129 * @param reg register to be selected
Geremia 20:14daa48ffd4c 130 * @param forread false = a write next (default), true = a read next
Geremia 20:14daa48ffd4c 131 * @note forread only used by SPI protocols
Geremia 20:14daa48ffd4c 132 */
Geremia 20:14daa48ffd4c 133 virtual void reg_select(unsigned char reg, bool forread =false) = 0;
Geremia 20:14daa48ffd4c 134
Geremia 20:14daa48ffd4c 135 /** ILI932x specific, write register with data
Geremia 20:14daa48ffd4c 136 *
Geremia 20:14daa48ffd4c 137 * @param reg register to write
Geremia 20:14daa48ffd4c 138 * @param data 16bit data
Geremia 20:14daa48ffd4c 139 */
Geremia 20:14daa48ffd4c 140 virtual void reg_write(unsigned char reg, unsigned short data) = 0;
Geremia 20:14daa48ffd4c 141
Geremia 20:14daa48ffd4c 142 /** ILI932x specific, read register
Geremia 20:14daa48ffd4c 143 *
Geremia 20:14daa48ffd4c 144 * @param reg register to be read
Geremia 20:14daa48ffd4c 145 * @returns 16bit register value
Geremia 20:14daa48ffd4c 146 */
Geremia 20:14daa48ffd4c 147 virtual unsigned short reg_read(unsigned char reg) = 0;
Geremia 20:14daa48ffd4c 148
Geremia 0:75ec1b3cde17 149 /** HW reset sequence (without display init commands)
Geremia 0:75ec1b3cde17 150 */
Geremia 0:75ec1b3cde17 151 virtual void hw_reset() = 0;
Geremia 0:75ec1b3cde17 152
Geremia 0:75ec1b3cde17 153 /** Set ChipSelect high or low
Geremia 0:75ec1b3cde17 154 * @param enable 0/1
Geremia 0:75ec1b3cde17 155 */
Geremia 0:75ec1b3cde17 156 virtual void BusEnable(bool enable) = 0;
Geremia 0:75ec1b3cde17 157
Geremia 0:75ec1b3cde17 158 };
Geremia 0:75ec1b3cde17 159 #endif