Fork of the UniGraphic-Library for monochrome LCDs with ST7920 controller and 128x64-IIC-OLED-Display with SH1106-Controller

Diff: Inits/ST7920.h

Revision:

35:b8d3f1e68000

Parent:

34:a9648877491f

--- a/Inits/ST7920.h	Sat May 20 21:12:05 2017 +0000
+++ b/Inits/ST7920.h	Sun May 21 20:50:09 2017 +0000
@@ -5,6 +5,7 @@
 #include "LCD.h"
 
 /** Class for ST7920 and similar display controllers
+* for Controller-details see http://www.alldatasheet.com/datasheet-pdf/pdf/326219/SITRONIX/ST7920.html
 * to be copypasted and adapted for other controllers
 */
 class ST7920 : public LCD
@@ -21,8 +22,8 @@
     * @param WR pin connected to SDI of display
     * @param RD pin connected to RS of display
     * @param name The name used by the parent class to access the interface
-    * @param LCDSIZE_X x size in pixel - optional
-    * @param LCDSIZE_Y y size in pixel - optional
+    * @param LCDSIZE_X x size in pixel 
+    * @param LCDSIZE_Y y size in pixel 
     */
     ST7920(proto_t displayproto, PortName port, PinName CS, PinName reset, PinName DC, PinName WR, PinName RD, const char* name, unsigned int LCDSIZE_X = 132, unsigned  int LCDSIZE_Y = 64);
 
@@ -35,8 +36,8 @@
     * @param WR pin connected to SDI of display
     * @param RD pin connected to RS of display
     * @param name The name used by the parent class to access the interface
-    * @param LCDSIZE_X x size in pixel - optional
-    * @param LCDSIZE_Y y size in pixel - optional
+    * @param LCDSIZE_X x size in pixel 
+    * @param LCDSIZE_Y y size in pixel 
     */
     ST7920(proto_t displayproto, PinName* buspins, PinName CS, PinName reset, PinName DC, PinName WR, PinName RD, const char* name, unsigned int LCDSIZE_X = 132, unsigned  int LCDSIZE_Y = 64);
 
@@ -50,8 +51,8 @@
     * @param reset pin connected to RESET of display
     * @param DC pin connected to data/command of display
     * @param name The name used by the parent class to access the interface
-    * @param LCDSIZE_X x size in pixel - optional
-    * @param LCDSIZE_Y y size in pixel - optional
+    * @param LCDSIZE_X x size in pixel 
+    * @param LCDSIZE_Y y size in pixel 
     */
     ST7920(proto_t displayproto, int Hz, PinName mosi, PinName miso, PinName sclk, PinName CS, PinName reset, PinName DC, const char* name, unsigned int LCDSIZE_X = 132, unsigned  int LCDSIZE_Y = 64);
 
@@ -71,33 +72,47 @@
 
 public:
     /** Mirror
+    // not needed, not supported
     */
     virtual void mirrorXY(mirror_t mode);
 
+    // Clear Screen
     virtual void cls(void);
 
+    //Copy screenbuffer to LCD
     virtual void copy_to_lcd(void);
     
+    //not supported by hardware
     virtual void set_contrast(int o);
     
+    //not supported by hardware
     void invert(unsigned char o);
     
+    //not supported by hardware
     virtual void wr_grambuf(unsigned short* data, unsigned int lenght);
     
+    //not supported by hardware
     virtual void wr_gram(unsigned short data);
     
+    //not supported by hardware
     virtual void wr_gram(unsigned short data, unsigned int count);
     
+    //not supported by hardware
     virtual void wr_data16(unsigned short data);
     
+    //not supported by hardware
     virtual void wr_cmd16(unsigned short cmd);
     
+    //not supported by hardware
     virtual void wr_cmd8(unsigned char cmd);
     
+    //not supported by hardware
     virtual unsigned short rd_gram(bool convert);
     
+    //not supported by hardware
     virtual unsigned int rd_reg_data32(unsigned char reg);
     
+    //not supported by hardware
     virtual unsigned int rd_extcreg_data32(unsigned char reg, unsigned char SPIreadenablecmd);
 
 };