mehmet gok / MemoryLCD

Fork of Silabs MemoryLCD library

Dependents:   demoUI whrmDemoUI Host_Software_MAX32664GWEB_HR_EXTENDED Host_Software_MAX32664GWEC_SpO2_HR-_EXTE ... more

C++ library for Sharp Microelectronics 1.28 inch LCD TFT, LS013B7DH03, SPI bus. Forked from Silicon Labs MemoryLCD display driver.

LS013B7DH03.h@1:6332f3383fb6, 2015-03-18 (annotated)

Committer:
Steven Cooreman
Date:
Wed Mar 18 10:58:34 2015 -0500
Revision:
1:6332f3383fb6
Parent:
0:a0faa86660d4
Child:
2:2f10f00fe56c
Doxygen error?

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Steven Cooreman 0:a0faa86660d4 1 /***************************************************************************//**
Steven Cooreman 0:a0faa86660d4 2 * @file LS013B7DH03.h
Steven Cooreman 0:a0faa86660d4 3 * @brief Driver class for the Sharp LS013B7DH03 memory LCD on some kits.
Steven Cooreman 0:a0faa86660d4 4 *******************************************************************************
Steven Cooreman 0:a0faa86660d4 5 * @section License
Steven Cooreman 0:a0faa86660d4 6 * <b>(C) Copyright 2015 Silicon Labs, http://www.silabs.com</b>
Steven Cooreman 0:a0faa86660d4 7 *******************************************************************************
Steven Cooreman 0:a0faa86660d4 8 *
Steven Cooreman 0:a0faa86660d4 9 * Permission is granted to anyone to use this software for any purpose,
Steven Cooreman 0:a0faa86660d4 10 * including commercial applications, and to alter it and redistribute it
Steven Cooreman 0:a0faa86660d4 11 * freely, subject to the following restrictions:
Steven Cooreman 0:a0faa86660d4 12 *
Steven Cooreman 0:a0faa86660d4 13 * 1. The origin of this software must not be misrepresented; you must not
Steven Cooreman 0:a0faa86660d4 14 * claim that you wrote the original software.
Steven Cooreman 0:a0faa86660d4 15 * 2. Altered source versions must be plainly marked as such, and must not be
Steven Cooreman 0:a0faa86660d4 16 * misrepresented as being the original software.
Steven Cooreman 0:a0faa86660d4 17 * 3. This notice may not be removed or altered from any source distribution.
Steven Cooreman 0:a0faa86660d4 18 *
Steven Cooreman 0:a0faa86660d4 19 * DISCLAIMER OF WARRANTY/LIMITATION OF REMEDIES: Silicon Labs has no
Steven Cooreman 0:a0faa86660d4 20 * obligation to support this Software. Silicon Labs is providing the
Steven Cooreman 0:a0faa86660d4 21 * Software "AS IS", with no express or implied warranties of any kind,
Steven Cooreman 0:a0faa86660d4 22 * including, but not limited to, any implied warranties of merchantability
Steven Cooreman 0:a0faa86660d4 23 * or fitness for any particular purpose or warranties against infringement
Steven Cooreman 0:a0faa86660d4 24 * of any proprietary rights of a third party.
Steven Cooreman 0:a0faa86660d4 25 *
Steven Cooreman 0:a0faa86660d4 26 * Silicon Labs will not be liable for any consequential, incidental, or
Steven Cooreman 0:a0faa86660d4 27 * special damages, or any other relief, or for any claim by any third party,
Steven Cooreman 0:a0faa86660d4 28 * arising from your use of this Software.
Steven Cooreman 0:a0faa86660d4 29 *
Steven Cooreman 0:a0faa86660d4 30 ******************************************************************************/
Steven Cooreman 0:a0faa86660d4 31
Steven Cooreman 0:a0faa86660d4 32 #ifndef SILABS_LS013B7DH03_H
Steven Cooreman 0:a0faa86660d4 33 #define SILABS_LS013B7DH03_H
Steven Cooreman 0:a0faa86660d4 34
Steven Cooreman 0:a0faa86660d4 35 #include "platform.h"
Steven Cooreman 0:a0faa86660d4 36 #include <mbed.h>
Steven Cooreman 0:a0faa86660d4 37 #include "CallbackPointer.h"
Steven Cooreman 0:a0faa86660d4 38 #include "LCDSettings.h"
Steven Cooreman 0:a0faa86660d4 39 #include "BufferedDisplay.h"
Steven Cooreman 0:a0faa86660d4 40
Steven Cooreman 0:a0faa86660d4 41 typedef void (*cbptr_t)(void);
Steven Cooreman 0:a0faa86660d4 42
Steven Cooreman 0:a0faa86660d4 43 #define LS013B7DH03_ERROR_BUSY -1
Steven Cooreman 0:a0faa86660d4 44 #define LS013B7DH03_ERROR_SPI_BUSY -2
Steven Cooreman 0:a0faa86660d4 45 #define LS013B7DH03_NO_ACTION -3
Steven Cooreman 0:a0faa86660d4 46 #define LS013B7DH03_ERROR_ARGUMENT -4
Steven Cooreman 0:a0faa86660d4 47 #define LS013B7DH03_OK 0
Steven Cooreman 0:a0faa86660d4 48
Steven Cooreman 0:a0faa86660d4 49 typedef enum {
Steven Cooreman 0:a0faa86660d4 50 IDLE, // No operation currently ongoing
Steven Cooreman 0:a0faa86660d4 51 CLEARING, // In the process of clearing the display
Steven Cooreman 0:a0faa86660d4 52 WRITING, // In the process of sending a display update
Steven Cooreman 0:a0faa86660d4 53 WAIT_CLEAR, // Going to clear after CS pin timeout
Steven Cooreman 0:a0faa86660d4 54 WAIT_WRITE, // Going to write after CS pin timeout
Steven Cooreman 0:a0faa86660d4 55 TRANSFERS_DONE, // Last transfer in progress
Steven Cooreman 0:a0faa86660d4 56 DONE // Done with transmission, waiting for CS pin to become high
Steven Cooreman 0:a0faa86660d4 57 } LS013B7DH03_state_t;
Steven Cooreman 0:a0faa86660d4 58
Steven Cooreman 0:a0faa86660d4 59 namespace silabs {
Steven Cooreman 0:a0faa86660d4 60 /** A driver for the Sharp LS013B7DH03 Memory LCD, present on some EFM32 Starter Kits.
Steven Cooreman 0:a0faa86660d4 61 *
Steven Cooreman 0:a0faa86660d4 62 * Currently supports LS013B7DH03 only, but should be easily modifiable.
Steven Cooreman 0:a0faa86660d4 63 *
Steven Cooreman 0:a0faa86660d4 64 * @code
Steven Cooreman 0:a0faa86660d4 65 * #include "mbed.h"
Steven Cooreman 0:a0faa86660d4 66 * #include "LS013B7DH03.h"
Steven Cooreman 0:a0faa86660d4 67 * #include "mbed_logo.h"
Steven Cooreman 0:a0faa86660d4 68 *
Steven Cooreman 0:a0faa86660d4 69 * #define SCK PE12
Steven Cooreman 0:a0faa86660d4 70 * #define MOSI PE10
Steven Cooreman 0:a0faa86660d4 71 *
Steven Cooreman 0:a0faa86660d4 72 * DigitalOut CS(PA10);
Steven Cooreman 0:a0faa86660d4 73 * DigitalOut EXTCOM(PF3);
Steven Cooreman 0:a0faa86660d4 74 * DigitalOut DISP(PA8);
Steven Cooreman 0:a0faa86660d4 75 *
Steven Cooreman 0:a0faa86660d4 76 * SPI displaySPI(MOSI, NC, SCK);
Steven Cooreman 0:a0faa86660d4 77 * silabs::LS013B7DH03 display(&displaySPI, &CS, &EXTCOM);
Steven Cooreman 0:a0faa86660d4 78 *
Steven Cooreman 0:a0faa86660d4 79 * volatile bool completed = false;
Steven Cooreman 0:a0faa86660d4 80 *
Steven Cooreman 0:a0faa86660d4 81 * void completionCallback( void ) {
Steven Cooreman 0:a0faa86660d4 82 * completed = true;
Steven Cooreman 0:a0faa86660d4 83 * }
Steven Cooreman 0:a0faa86660d4 84 *
Steven Cooreman 0:a0faa86660d4 85 * int main() {
Steven Cooreman 0:a0faa86660d4 86 * //Enable the LCD
Steven Cooreman 0:a0faa86660d4 87 * DISP = 1;
Steven Cooreman 0:a0faa86660d4 88 *
Steven Cooreman 0:a0faa86660d4 89 * // Reset the LCD to a blank state. (All white)
Steven Cooreman 0:a0faa86660d4 90 * completed = false;
Steven Cooreman 0:a0faa86660d4 91 * display.clearImmediate(completionCallback);
Steven Cooreman 0:a0faa86660d4 92 * while(completed == false) sleep();
Steven Cooreman 0:a0faa86660d4 93 *
Steven Cooreman 0:a0faa86660d4 94 * printf("Initialization done! \n");
Steven Cooreman 0:a0faa86660d4 95 *
Steven Cooreman 0:a0faa86660d4 96 * // Push update to the display
Steven Cooreman 0:a0faa86660d4 97 * uint32_t refreshCount = display.getRefreshTicks();
Steven Cooreman 0:a0faa86660d4 98 * completed = false;
Steven Cooreman 0:a0faa86660d4 99 * display.update(completionCallback);
Steven Cooreman 0:a0faa86660d4 100 *
Steven Cooreman 0:a0faa86660d4 101 * // Sleep while doing the transmit
Steven Cooreman 0:a0faa86660d4 102 * while(refreshed == false) sleep();
Steven Cooreman 0:a0faa86660d4 103 *
Steven Cooreman 0:a0faa86660d4 104 * // Calculate and print refresh duration
Steven Cooreman 0:a0faa86660d4 105 * refreshCount = display.getRefreshTicks() - refreshCount;
Steven Cooreman 0:a0faa86660d4 106 * printf("Refresh duration: %d cycles @ 125Hz \n", (int)refreshCount);
Steven Cooreman 0:a0faa86660d4 107 *
Steven Cooreman 0:a0faa86660d4 108 * // Sleep forever.
Steven Cooreman 0:a0faa86660d4 109 * while(1) sleep();
Steven Cooreman 0:a0faa86660d4 110 * }
Steven Cooreman 0:a0faa86660d4 111 * @endcode
Steven Cooreman 0:a0faa86660d4 112 */
Steven Cooreman 1:6332f3383fb6 113 class LS013B7DH03 : public BufferedDisplay {
Steven Cooreman 0:a0faa86660d4 114 public:
Steven Cooreman 0:a0faa86660d4 115
Steven Cooreman 0:a0faa86660d4 116 LS013B7DH03(SPI * spi, DigitalOut * CS, DigitalOut * ExtCom, const char *name=NULL);
Steven Cooreman 0:a0faa86660d4 117
Steven Cooreman 0:a0faa86660d4 118 /**
Steven Cooreman 0:a0faa86660d4 119 * Call this function to push all changes to the display
Steven Cooreman 0:a0faa86660d4 120 *
Steven Cooreman 0:a0faa86660d4 121 * @param callback void (void) type callback pointer to call on display update completion.
Steven Cooreman 0:a0faa86660d4 122 * @return Status code
Steven Cooreman 0:a0faa86660d4 123 */
Steven Cooreman 0:a0faa86660d4 124 int update( cbptr_t callback = NULL );
Steven Cooreman 0:a0faa86660d4 125
Steven Cooreman 0:a0faa86660d4 126 /**
Steven Cooreman 0:a0faa86660d4 127 * Immediately clear the display: set pixel buffer to zero and clear out the display.
Steven Cooreman 0:a0faa86660d4 128 *
Steven Cooreman 0:a0faa86660d4 129 * @param callback void (void) type callback pointer to call on display clear completion.
Steven Cooreman 0:a0faa86660d4 130 * @return Status code
Steven Cooreman 0:a0faa86660d4 131 */
Steven Cooreman 0:a0faa86660d4 132 int clearImmediate( cbptr_t callback = NULL );
Steven Cooreman 0:a0faa86660d4 133
Steven Cooreman 0:a0faa86660d4 134 /**
Steven Cooreman 0:a0faa86660d4 135 * Function to test display buffer
Steven Cooreman 0:a0faa86660d4 136 *
Steven Cooreman 0:a0faa86660d4 137 * @return Status code
Steven Cooreman 0:a0faa86660d4 138 */
Steven Cooreman 0:a0faa86660d4 139 int showDemo();
Steven Cooreman 0:a0faa86660d4 140
Steven Cooreman 0:a0faa86660d4 141 /**
Steven Cooreman 0:a0faa86660d4 142 * Function to get internal 128Hz refresh counter. Can be useful for performance measurement.
Steven Cooreman 0:a0faa86660d4 143 *
Steven Cooreman 0:a0faa86660d4 144 * @return Number of display toggle ticks since init
Steven Cooreman 0:a0faa86660d4 145 */
Steven Cooreman 0:a0faa86660d4 146 uint32_t getRefreshTicks();
Steven Cooreman 0:a0faa86660d4 147
Steven Cooreman 0:a0faa86660d4 148 protected:
Steven Cooreman 0:a0faa86660d4 149 mbed::SPI *_spi;
Steven Cooreman 0:a0faa86660d4 150 mbed::DigitalOut *_EXTCOM;
Steven Cooreman 0:a0faa86660d4 151 mbed::DigitalOut *_CS;
Steven Cooreman 0:a0faa86660d4 152
Steven Cooreman 0:a0faa86660d4 153 mbed::LowPowerTicker _displayToggler;
Steven Cooreman 0:a0faa86660d4 154 mbed::LowPowerTimeout _csTimeout;
Steven Cooreman 0:a0faa86660d4 155
Steven Cooreman 0:a0faa86660d4 156 mbed::CallbackPointer _internalCallback;
Steven Cooreman 0:a0faa86660d4 157 volatile uint32_t _refreshCount;
Steven Cooreman 0:a0faa86660d4 158 uint8_t _lcdPolarity;
Steven Cooreman 0:a0faa86660d4 159 LS013B7DH03_state_t _state;
Steven Cooreman 0:a0faa86660d4 160 cbptr_t _completionCallbackPtr;
Steven Cooreman 0:a0faa86660d4 161 volatile uint32_t _rowCount;
Steven Cooreman 0:a0faa86660d4 162 uint8_t _cmd[2 + (DISPLAY_WIDTH / DISPLAY_BUFFER_TYPE_SIZE * sizeof(DISPLAY_BUFFER_TYPE))];
Steven Cooreman 0:a0faa86660d4 163
Steven Cooreman 0:a0faa86660d4 164 /**
Steven Cooreman 0:a0faa86660d4 165 * Callback handler for internal SPI transfers.
Steven Cooreman 0:a0faa86660d4 166 */
Steven Cooreman 0:a0faa86660d4 167 void _cbHandler( int event );
Steven Cooreman 0:a0faa86660d4 168
Steven Cooreman 0:a0faa86660d4 169 /**
Steven Cooreman 0:a0faa86660d4 170 * Callback handler for internal SPI transfers triggered by timeout.
Steven Cooreman 0:a0faa86660d4 171 */
Steven Cooreman 0:a0faa86660d4 172 void _cbHandlerTimeout( void );
Steven Cooreman 0:a0faa86660d4 173
Steven Cooreman 0:a0faa86660d4 174 /**
Steven Cooreman 0:a0faa86660d4 175 * Call this function at 128 Hz to keep the display from losing contrast.
Steven Cooreman 0:a0faa86660d4 176 */
Steven Cooreman 0:a0faa86660d4 177 void toggle();
Steven Cooreman 0:a0faa86660d4 178 };
Steven Cooreman 0:a0faa86660d4 179
Steven Cooreman 0:a0faa86660d4 180 } // namespace silabs
Steven Cooreman 0:a0faa86660d4 181
Steven Cooreman 0:a0faa86660d4 182 #endif //SILABS_LS013B7DH03_H