SSD1306 OLED display driver  1.7.17
This library is developed to control SSD1306/SSD1331/SSD1351/IL9163/PCD8554 RGB i2c/spi LED displays
oled_ssd1306.c
1 /*
2  MIT License
3 
4  Copyright (c) 2017-2019, Alexey Dynda
5 
6  Permission is hereby granted, free of charge, to any person obtaining a copy
7  of this software and associated documentation files (the "Software"), to deal
8  in the Software without restriction, including without limitation the rights
9  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10  copies of the Software, and to permit persons to whom the Software is
11  furnished to do so, subject to the following conditions:
12 
13  The above copyright notice and this permission notice shall be included in all
14  copies or substantial portions of the Software.
15 
16  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22  SOFTWARE.
23 */
24 
25 #include "oled_ssd1306.h"
26 #include "lcd_common.h"
27 #include "ssd1306_commands.h"
28 #include "intf/ssd1306_interface.h"
29 #include "intf/i2c/ssd1306_i2c.h"
30 #include "intf/spi/ssd1306_spi.h"
31 #include "ssd1306_hal/io.h"
32 #ifdef SDL_EMULATION
33 #include "sdl_core.h"
34 #endif
35 
36 
37 static const uint8_t PROGMEM s_oled128x64_initData[] =
38 {
39 #ifdef SDL_EMULATION
40  SDL_LCD_SSD1306,
41  0x00,
42 #endif
43  SSD1306_DISPLAYOFF, // display off
44  SSD1306_MEMORYMODE, HORIZONTAL_ADDRESSING_MODE, // Page Addressing mode
45  SSD1306_COMSCANDEC, // Scan from 127 to 0 (Reverse scan)
46  SSD1306_SETSTARTLINE | 0x00, // First line to start scanning from
47  SSD1306_SETCONTRAST, 0x7F, // contast value to 0x7F according to datasheet
48  SSD1306_SEGREMAP | 0x01, // Use reverse mapping. 0x00 - is normal mapping
49  SSD1306_NORMALDISPLAY,
50  SSD1306_SETMULTIPLEX, 63, // Reset to default MUX. See datasheet
51  SSD1306_SETDISPLAYOFFSET, 0x00, // no offset
52  SSD1306_SETDISPLAYCLOCKDIV, 0x80,// set to default ratio/osc frequency
53  SSD1306_SETPRECHARGE, 0x22, // switch precharge to 0x22 // 0xF1
54  SSD1306_SETCOMPINS, 0x12, // set divide ratio
55  SSD1306_SETVCOMDETECT, 0x20, // vcom deselect to 0x20 // 0x40
56  SSD1306_CHARGEPUMP, 0x14, // Enable charge pump
57  SSD1306_DISPLAYALLON_RESUME,
58  SSD1306_DISPLAYON,
59 };
60 
61 static const uint8_t PROGMEM s_oled128x32_initData[] =
62 {
63 #ifdef SDL_EMULATION
64  SDL_LCD_SSD1306,
65  0x00,
66 #endif
67  SSD1306_DISPLAYOFF, // display off
68  SSD1306_SETDISPLAYCLOCKDIV, 0x80,
69  SSD1306_SETMULTIPLEX, 31,
70  SSD1306_SETDISPLAYOFFSET, 0x00, // --no offset
71  SSD1306_SETSTARTLINE | 0x00,
72  SSD1306_CHARGEPUMP, 0x14, // 0x10
73  SSD1306_SEGREMAP | 0x01, // Reverse mapping
74  SSD1306_COMSCANDEC,
75  SSD1306_SETCOMPINS, 0x02,
76  SSD1306_SETCONTRAST, 0x7F, // contast value
77  SSD1306_SETPRECHARGE, 0x22, // 0x1F
78  SSD1306_SETVCOMDETECT, 0x40,
79  SSD1306_MEMORYMODE, HORIZONTAL_ADDRESSING_MODE,
80  SSD1306_DISPLAYALLON_RESUME,
81  SSD1306_NORMALDISPLAY,
82  SSD1306_DISPLAYON,
83 };
84 
85 static void ssd1306_setBlock(lcduint_t x, lcduint_t y, lcduint_t w)
86 {
88  if (ssd1306_intf.spi)
90  else
91  ssd1306_intf.send(0x00);
92  ssd1306_intf.send(SSD1306_COLUMNADDR);
93  ssd1306_intf.send(x);
94  ssd1306_intf.send(w ? (x + w - 1) : (ssd1306_lcd.width - 1));
95  ssd1306_intf.send(SSD1306_PAGEADDR);
96  ssd1306_intf.send(y);
97  ssd1306_intf.send((ssd1306_lcd.height >> 3) - 1);
98  if (ssd1306_intf.spi)
99  {
101  }
102  else
103  {
104  ssd1306_intf.stop();
106  ssd1306_intf.send(0x40);
107  }
108 }
109 
110 static void ssd1306_nextPage(void)
111 {
112 }
113 
114 static void ssd1306_setMode_int(lcd_mode_t mode)
115 {
116 }
117 
119 {
120  ssd1306_sendCommand(SSD1306_DISPLAYOFF);
121 }
122 
123 
125 {
126  ssd1306_sendCommand(SSD1306_DISPLAYON);
127 }
128 
129 void ssd1306_setContrast(uint8_t contrast)
130 {
132  ssd1306_intf.send(SSD1306_SETCONTRAST);
133  ssd1306_intf.send(contrast);
134  ssd1306_intf.stop();
135 }
136 
138 {
139  ssd1306_sendCommand(SSD1306_INVERTDISPLAY);
140 }
141 
143 {
144  ssd1306_sendCommand(SSD1306_NORMALDISPLAY);
145 }
146 
147 void ssd1306_flipHorizontal(uint8_t mode)
148 {
149  ssd1306_sendCommand( SSD1306_SEGREMAP | (mode ? 0x00: 0x01 ) );
150 }
151 
152 void ssd1306_flipVertical(uint8_t mode)
153 {
154  ssd1306_sendCommand( mode ? SSD1306_COMSCANINC : SSD1306_COMSCANDEC );
155 }
156 
157 void ssd1306_setStartLine(uint8_t line)
158 {
159  ssd1306_sendCommand( SSD1306_SETSTARTLINE | (line & 0x3F) );
160 }
161 
163 // I2C SSD1306 128x64
165 
167 {
169 }
170 
171 
173 {
175  ssd1306_lcd.height = 64;
176  ssd1306_lcd.width = 128;
177  ssd1306_lcd.set_block = ssd1306_setBlock;
178  ssd1306_lcd.next_page = ssd1306_nextPage;
181  ssd1306_lcd.set_mode = ssd1306_setMode_int;
182  for( uint8_t i=0; i<sizeof(s_oled128x64_initData); i++)
183  {
184  ssd1306_sendCommand(pgm_read_byte(&s_oled128x64_initData[i]));
185  }
186 }
187 
189 {
190  ssd1306_i2cInit();
192 }
193 
194 void ssd1306_128x64_i2c_initEx(int8_t scl, int8_t sda, int8_t sa)
195 {
196  ssd1306_i2cInitEx(scl, sda, sa);
198 }
199 
201 // SPI SSD1306 128x64
203 
204 void ssd1306_128x64_spi_init(int8_t rstPin, int8_t cesPin, int8_t dcPin)
205 {
206  if (rstPin >=0)
207  {
208  ssd1306_resetController( rstPin, 10 );
209  }
210  ssd1306_spiInit(cesPin, dcPin);
212 }
213 
215 // I2C SSD1306 128x32
217 
219 {
221  ssd1306_lcd.height = 32;
222  ssd1306_lcd.width = 128;
223  ssd1306_lcd.set_block = ssd1306_setBlock;
224  ssd1306_lcd.next_page = ssd1306_nextPage;
226  ssd1306_lcd.set_mode = ssd1306_setMode_int;
227  for( uint8_t i=0; i < sizeof(s_oled128x32_initData); i++)
228  {
229  ssd1306_sendCommand(pgm_read_byte(&s_oled128x32_initData[i]));
230  }
231 }
232 
233 
235 {
236  ssd1306_i2cInit();
238 }
239 
241 // SPI SSD1306 128x32
243 
244 void ssd1306_128x32_spi_init(int8_t rstPin, int8_t cesPin, int8_t dcPin)
245 {
246  if (rstPin >=0)
247  {
248  ssd1306_resetController( rstPin, 10 );
249  }
250  ssd1306_spiInit(cesPin, dcPin);
252 }
void ssd1306_i2cInit()
Definition: ssd1306_i2c.c:42
void ssd1306_flipVertical(uint8_t mode)
performs vertical flip
Definition: oled_ssd1306.c:152
void ssd1306_invertMode(void)
Definition: oled_ssd1306.c:137
void ssd1306_setContrast(uint8_t contrast)
Definition: oled_ssd1306.c:129
void(* send)(uint8_t data)
void ssd1306_128x32_init(void)
Inits 128x32 OLED display (based on ssd1306 controller).
Definition: oled_ssd1306.c:218
void ssd1306_128x64_spi_init(int8_t rstPin, int8_t cesPin, int8_t dcPin)
Inits 128x64 OLED display over spi (based on SSD1306 controller).
Definition: oled_ssd1306.c:204
void ssd1306_displayOff(void)
Definition: oled_ssd1306.c:118
void ssd1306_flipHorizontal(uint8_t mode)
performs horizontal flip
Definition: oled_ssd1306.c:147
void(* set_block)(lcduint_t x, lcduint_t y, lcduint_t w)
Sets block in RAM of lcd display controller to write data to.
Definition: lcd_common.h:114
void ssd1306_spiDataMode(uint8_t mode)
Definition: ssd1306_spi.c:50
lcd_mode_t
Definition: lcd_common.h:69
void(* send_pixels_buffer1)(const uint8_t *buffer, uint16_t len)
Definition: lcd_common.h:135
void ssd1306_resetController(int8_t rstPin, uint8_t delayMs)
Does hardware reset for oled controller.
Definition: lcd_common.c:82
void ssd1306_128x64_init()
Inits 128x64 OLED display (based on SSD1306 controller).
Definition: oled_ssd1306.c:172
void(* send_pixels1)(uint8_t data)
Definition: lcd_common.h:128
void ssd1306_128x64_i2c_initEx(int8_t scl, int8_t sda, int8_t sa)
Inits 128x64 OLED display over i2c (based on SSD1306 controller).
Definition: oled_ssd1306.c:194
void ssd1306_spiInit(int8_t cesPin, int8_t dcPin)
Definition: ssd1306_spi.c:37
ssd1306_lcd_t ssd1306_lcd
Definition: lcd_common.c:32
void ssd1306_128x32_i2c_init(void)
Inits 128x32 OLED display over i2c (based on SSD1306 controller).
Definition: oled_ssd1306.c:234
ssd1306_interface_t ssd1306_intf
void ssd1306_128x64_i2c_init(void)
Inits 128x64 OLED display over i2c (based on SSD1306 controller).
Definition: oled_ssd1306.c:188
void ssd1306_i2cInitEx(int8_t scl, int8_t sda, int8_t sa)
Definition: ssd1306_i2c.c:28
lcduint_t height
Definition: lcd_common.h:97
void ssd1306_displayOn(void)
Definition: oled_ssd1306.c:124
void ssd1306_setStartLine(uint8_t line)
Definition: oled_ssd1306.c:157
void ssd1306_128x32_spi_init(int8_t rstPin, int8_t cesPin, int8_t dcPin)
Inits 128x32 OLED display over spi (based on SSD1306 controller).
Definition: oled_ssd1306.c:244
void ssd1306_commandStart(void)
void ssd1306_sendCommand(uint8_t command)
void(* send_buffer)(const uint8_t *buffer, uint16_t size)
Sends bytes to SSD1306 device.
void(* next_page)(void)
Definition: lcd_common.h:122
lcduint_t width
Definition: lcd_common.h:94
lcd_type_t type
Definition: lcd_common.h:91
void ssd1306_normalMode(void)
Definition: oled_ssd1306.c:142
void ssd1306_init(void) __attribute__((deprecated))
Inits 128x64 OLED display over i2c (based on SSD1306 controller).
Definition: oled_ssd1306.c:166
void(* set_mode)(lcd_mode_t mode)
Sets library display mode for direct draw functions.
Definition: lcd_common.h:164