Satyan Raj / UniGraphic

test

Fork of UniGraphic by GraphicsDisplay

Protocols/Protocols.h@21:ae0a4eedfc90, 2015-03-31 (annotated)

Committer:
Geremia
Date:
Tue Mar 31 21:14:48 2015 +0000
Revision:
21:ae0a4eedfc90
Parent:
20:14daa48ffd4c 
Add BUS_8 and BUS_16 (slow as expected)

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