Satyan Raj / UniGraphic

test

Fork of UniGraphic by GraphicsDisplay

Protocols/Protocols.h@7:bb0383b91104, 2015-02-17 (annotated)

Committer:
Geremia
Date:
Tue Feb 17 11:02:06 2015 +0000
Revision:
7:bb0383b91104
Parent:
6:8356d48a07db
Child:
11:b842b8e332cb
TFT: added get deviceID, scroll functions

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 5:b222a9461d6b 13 #define RGB18to16(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 0:75ec1b3cde17 21 PAR_8 /**< Parallel 8bit, pins 0 to 7 */
Geremia 0:75ec1b3cde17 22 ,PAR_16 /**< Parallel 16bit, pins 0 to 15 */
Geremia 0:75ec1b3cde17 23 ,SPI_8 /**< SPI 8bit */
Geremia 0:75ec1b3cde17 24 ,SPI_16 /**< SPI 16bit */
Geremia 0:75ec1b3cde17 25 };
Geremia 0:75ec1b3cde17 26
Geremia 0:75ec1b3cde17 27
Geremia 6:8356d48a07db 28 /** Abstract interface class for spi and parallel protocols
Geremia 0:75ec1b3cde17 29 */
Geremia 0:75ec1b3cde17 30 class Protocols
Geremia 0:75ec1b3cde17 31 {
Geremia 0:75ec1b3cde17 32 public:
Geremia 0:75ec1b3cde17 33
Geremia 1:ff019d22b275 34 /** Send 8bit command to display controller
Geremia 0:75ec1b3cde17 35 *
Geremia 0:75ec1b3cde17 36 * @param cmd: byte to send
Geremia 0:75ec1b3cde17 37 *
Geremia 0:75ec1b3cde17 38 */
Geremia 1:ff019d22b275 39 virtual void wr_cmd8(unsigned char cmd) = 0;
Geremia 0:75ec1b3cde17 40
Geremia 1:ff019d22b275 41 /** Send 8bit data to display controller
Geremia 0:75ec1b3cde17 42 *
Geremia 1:ff019d22b275 43 * @param data: byte to send
Geremia 0:75ec1b3cde17 44 *
Geremia 0:75ec1b3cde17 45 */
Geremia 1:ff019d22b275 46 virtual void wr_data8(unsigned char data) = 0;
Geremia 0:75ec1b3cde17 47
Geremia 4:12ba0ecc2c1f 48 /** Send 2x8bit command to display controller
Geremia 1:ff019d22b275 49 *
Geremia 1:ff019d22b275 50 * @param cmd: halfword to send
Geremia 1:ff019d22b275 51 *
Geremia 1:ff019d22b275 52 */
Geremia 1:ff019d22b275 53 virtual void wr_cmd16(unsigned short cmd) = 0;
Geremia 1:ff019d22b275 54
Geremia 4:12ba0ecc2c1f 55 /** Send 2x8bit data to display controller
Geremia 1:ff019d22b275 56 *
Geremia 1:ff019d22b275 57 * @param data: halfword to send
Geremia 0:75ec1b3cde17 58 *
Geremia 0:75ec1b3cde17 59 */
Geremia 1:ff019d22b275 60 virtual void wr_data16(unsigned short data) = 0;
Geremia 1:ff019d22b275 61
Geremia 4:12ba0ecc2c1f 62 /** Send 16bit pixeldata to display controller
Geremia 4:12ba0ecc2c1f 63 *
Geremia 4:12ba0ecc2c1f 64 * @param data: halfword to send
Geremia 4:12ba0ecc2c1f 65 *
Geremia 4:12ba0ecc2c1f 66 */
Geremia 4:12ba0ecc2c1f 67 virtual void wr_gram(unsigned short data) = 0;
Geremia 4:12ba0ecc2c1f 68
Geremia 4:12ba0ecc2c1f 69 /** Send same 16bit pixeldata to display controller multiple times
Geremia 1:ff019d22b275 70 *
Geremia 1:ff019d22b275 71 * @param data: halfword to send
Geremia 1:ff019d22b275 72 * @param count: how many
Geremia 1:ff019d22b275 73 *
Geremia 1:ff019d22b275 74 */
Geremia 4:12ba0ecc2c1f 75 virtual void wr_gram(unsigned short data, unsigned int count) = 0;
Geremia 1:ff019d22b275 76
Geremia 4:12ba0ecc2c1f 77 /** Send array of pixeldata shorts to display controller
Geremia 1:ff019d22b275 78 *
Geremia 4:12ba0ecc2c1f 79 * @param data: unsigned short pixeldata array
Geremia 1:ff019d22b275 80 * @param lenght: lenght (in shorts)
Geremia 1:ff019d22b275 81 *
Geremia 1:ff019d22b275 82 */
Geremia 4:12ba0ecc2c1f 83 virtual void wr_grambuf(unsigned short* data, unsigned int lenght) = 0;
Geremia 0:75ec1b3cde17 84
Geremia 5:b222a9461d6b 85 /** Read 16bit pixeldata from display controller (with dummy cycle)
Geremia 5:b222a9461d6b 86 *
Geremia 5:b222a9461d6b 87 * @returns 16bit color
Geremia 5:b222a9461d6b 88 */
Geremia 5:b222a9461d6b 89 virtual unsigned short rd_gram() = 0;
Geremia 5:b222a9461d6b 90
Geremia 7:bb0383b91104 91 /** Read 4x8bit register data (with dummy cycle)
Geremia 7:bb0383b91104 92 * @param reg the register to read
Geremia 7:bb0383b91104 93 * @returns data as uint
Geremia 7:bb0383b91104 94 *
Geremia 7:bb0383b91104 95 */
Geremia 7:bb0383b91104 96 virtual unsigned int rd_reg_data32(unsigned char reg) = 0;
Geremia 7:bb0383b91104 97
Geremia 7:bb0383b91104 98 /** Read 3x8bit ExtendedCommands register data
Geremia 7:bb0383b91104 99 * @param reg the register to read
Geremia 7:bb0383b91104 100 * @param SPIreadenablecmd vendor/device specific cmd to read EXTC registers
Geremia 7:bb0383b91104 101 * @returns data as uint
Geremia 7:bb0383b91104 102 * @note EXTC regs (0xB0 to 0xFF) are read/write registers but needs special cmd to be read in SPI mode
Geremia 7:bb0383b91104 103 */
Geremia 7:bb0383b91104 104 virtual unsigned int rd_extcreg_data32(unsigned char reg, unsigned char SPIreadenablecmd) = 0;
Geremia 7:bb0383b91104 105
Geremia 0:75ec1b3cde17 106 /** HW reset sequence (without display init commands)
Geremia 0:75ec1b3cde17 107 */
Geremia 0:75ec1b3cde17 108 virtual void hw_reset() = 0;
Geremia 0:75ec1b3cde17 109
Geremia 0:75ec1b3cde17 110 /** Set ChipSelect high or low
Geremia 0:75ec1b3cde17 111 * @param enable 0/1
Geremia 0:75ec1b3cde17 112 */
Geremia 0:75ec1b3cde17 113 virtual void BusEnable(bool enable) = 0;
Geremia 0:75ec1b3cde17 114
Geremia 0:75ec1b3cde17 115 };
Geremia 0:75ec1b3cde17 116 #endif