| 1 | /* |
| 2 | |
| 3 | u8x8_d_ks0108.c |
| 4 | |
| 5 | The classic 5V LCD |
| 6 | |
| 7 | Universal 8bit Graphics Library (https://github.com/olikraus/u8g2/) |
| 8 | |
| 9 | Copyright (c) 2016, olikraus@gmail.com |
| 10 | All rights reserved. |
| 11 | |
| 12 | Redistribution and use in source and binary forms, with or without modification, |
| 13 | are permitted provided that the following conditions are met: |
| 14 | |
| 15 | * Redistributions of source code must retain the above copyright notice, this list |
| 16 | of conditions and the following disclaimer. |
| 17 | |
| 18 | * Redistributions in binary form must reproduce the above copyright notice, this |
| 19 | list of conditions and the following disclaimer in the documentation and/or other |
| 20 | materials provided with the distribution. |
| 21 | |
| 22 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND |
| 23 | CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, |
| 24 | INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF |
| 25 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
| 26 | DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR |
| 27 | CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| 28 | SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT |
| 29 | NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; |
| 30 | LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER |
| 31 | CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, |
| 32 | STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
| 33 | ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF |
| 34 | ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| 35 | |
| 36 | |
| 37 | */ |
| 38 | #include "u8x8.h" |
| 39 | |
| 40 | |
| 41 | |
| 42 | |
| 43 | static const uint8_t u8x8_d_ks0108_init_seq[] = { |
| 44 | U8X8_C(0x0c0), /* start at the top */ |
| 45 | U8X8_END() /* end of sequence */ |
| 46 | }; |
| 47 | |
| 48 | static const uint8_t u8x8_d_ks0108_powersave0_seq[] = { |
| 49 | U8X8_C(0x03f), /* display on */ |
| 50 | U8X8_END() /* end of sequence */ |
| 51 | }; |
| 52 | |
| 53 | static const uint8_t u8x8_d_ks0108_powersave1_seq[] = { |
| 54 | U8X8_C(0x03e), /* display off */ |
| 55 | U8X8_END() /* end of sequence */ |
| 56 | }; |
| 57 | |
| 58 | |
| 59 | struct u8x8_ks0108_vars |
| 60 | { |
| 61 | uint8_t *ptr; |
| 62 | uint8_t x; |
| 63 | uint8_t c; |
| 64 | uint8_t arg_int; |
| 65 | }; |
| 66 | |
| 67 | static void u8x8_ks0108_out(u8x8_t *u8x8, struct u8x8_ks0108_vars *v, void *arg_ptr) |
| 68 | { |
| 69 | uint8_t cnt; |
| 70 | u8x8_cad_SendCmd(u8x8, 0x040 | ((v->x << 3) & 63) ); |
| 71 | u8x8_cad_SendCmd(u8x8, 0x0b8 | (((u8x8_tile_t *)arg_ptr)->y_pos)); |
| 72 | |
| 73 | while( v->arg_int > 0 ) |
| 74 | { |
| 75 | /* calculate tiles to next boundary (end or chip limit) */ |
| 76 | cnt = v->x; |
| 77 | cnt += 8; |
| 78 | cnt &= 0x0f8; |
| 79 | cnt -= v->x; |
| 80 | |
| 81 | if ( cnt > v->c ) |
| 82 | cnt = v->c; |
| 83 | |
| 84 | /* of cours we still could use cnt=1 here... */ |
| 85 | /* but setting cnt to 1 is not very efficient */ |
| 86 | //cnt = 1; |
| 87 | |
| 88 | v->x +=cnt; |
| 89 | v->c-=cnt; |
| 90 | cnt<<=3; |
| 91 | u8x8_cad_SendData(u8x8, cnt, v->ptr); /* note: SendData can not handle more than 255 bytes */ |
| 92 | v->ptr += cnt; |
| 93 | |
| 94 | if ( v->c == 0 ) |
| 95 | { |
| 96 | v->ptr = ((u8x8_tile_t *)arg_ptr)->tile_ptr; |
| 97 | v->c = ((u8x8_tile_t *)arg_ptr)->cnt; |
| 98 | v->arg_int--; |
| 99 | } |
| 100 | if ( ((v->x) & 7) == 0 ) |
| 101 | break; |
| 102 | } |
| 103 | } |
| 104 | |
| 105 | |
| 106 | static const u8x8_display_info_t u8x8_ks0108_128x64_display_info = |
| 107 | { |
| 108 | /* chip_enable_level = */ 0, /* KS0108: Not used */ |
| 109 | /* chip_disable_level = */ 1, /* KS0108: Not used */ |
| 110 | |
| 111 | /* post_chip_enable_wait_ns = */ 100, |
| 112 | /* pre_chip_disable_wait_ns = */ 20, |
| 113 | /* reset_pulse_width_ms = */ 5, |
| 114 | /* post_reset_wait_ms = */ 6, /* could be faster for the KS0108 */ |
| 115 | /* sda_setup_time_ns = */ 12, |
| 116 | /* sck_pulse_width_ns = */ 75, /* KS0108: Not used */ |
| 117 | /* sck_clock_hz = */ 4000000UL, /* KS0108: Not used */ |
| 118 | /* spi_mode = */ 0, /* active high, rising edge */ |
| 119 | /* i2c_bus_clock_100kHz = */ 4, /* KS0108: Not used */ |
| 120 | /* data_setup_time_ns = */ 200, |
| 121 | /* write_pulse_width_ns = */ 250, /* KS0108: actially 450 ns, but additional 200 ns are added by the byte transfer function */ |
| 122 | /* tile_width = */ 16, /* width of 16*8=128 pixel */ |
| 123 | /* tile_height = */ 8, |
| 124 | /* default_x_offset = */ 0, |
| 125 | /* flipmode_x_offset = */ 0, |
| 126 | /* pixel_width = */ 128, |
| 127 | /* pixel_height = */ 64 |
| 128 | }; |
| 129 | |
| 130 | uint8_t u8x8_d_ks0108_128x64(u8x8_t *u8x8, uint8_t msg, uint8_t arg_int, void *arg_ptr) |
| 131 | { |
| 132 | struct u8x8_ks0108_vars v; |
| 133 | switch(msg) |
| 134 | { |
| 135 | case U8X8_MSG_DISPLAY_SETUP_MEMORY: |
| 136 | u8x8_d_helper_display_setup_memory(u8x8, &u8x8_ks0108_128x64_display_info); |
| 137 | break; |
| 138 | case U8X8_MSG_DISPLAY_INIT: |
| 139 | u8x8_d_helper_display_init(u8x8); |
| 140 | |
| 141 | u8x8->cad_cb(u8x8, U8X8_MSG_CAD_START_TRANSFER, 1, NULL); |
| 142 | u8x8_cad_SendSequence(u8x8, u8x8_d_ks0108_init_seq); |
| 143 | u8x8->cad_cb(u8x8, U8X8_MSG_CAD_END_TRANSFER, 0, NULL); |
| 144 | |
| 145 | u8x8->cad_cb(u8x8, U8X8_MSG_CAD_START_TRANSFER, 2, NULL); |
| 146 | u8x8_cad_SendSequence(u8x8, u8x8_d_ks0108_init_seq); |
| 147 | u8x8->cad_cb(u8x8, U8X8_MSG_CAD_END_TRANSFER, 0, NULL); |
| 148 | break; |
| 149 | case U8X8_MSG_DISPLAY_SET_POWER_SAVE: |
| 150 | |
| 151 | if ( arg_int == 0 ) |
| 152 | { |
| 153 | u8x8->cad_cb(u8x8, U8X8_MSG_CAD_START_TRANSFER, 1, NULL); |
| 154 | u8x8_cad_SendSequence(u8x8, u8x8_d_ks0108_powersave0_seq); |
| 155 | u8x8->cad_cb(u8x8, U8X8_MSG_CAD_END_TRANSFER, 0, NULL); |
| 156 | |
| 157 | u8x8->cad_cb(u8x8, U8X8_MSG_CAD_START_TRANSFER, 2, NULL); |
| 158 | u8x8_cad_SendSequence(u8x8, u8x8_d_ks0108_powersave0_seq); |
| 159 | u8x8->cad_cb(u8x8, U8X8_MSG_CAD_END_TRANSFER, 0, NULL); |
| 160 | |
| 161 | } |
| 162 | else |
| 163 | { |
| 164 | u8x8->cad_cb(u8x8, U8X8_MSG_CAD_START_TRANSFER, 1, NULL); |
| 165 | u8x8_cad_SendSequence(u8x8, u8x8_d_ks0108_powersave1_seq); |
| 166 | u8x8->cad_cb(u8x8, U8X8_MSG_CAD_END_TRANSFER, 0, NULL); |
| 167 | |
| 168 | u8x8->cad_cb(u8x8, U8X8_MSG_CAD_START_TRANSFER, 2, NULL); |
| 169 | u8x8_cad_SendSequence(u8x8, u8x8_d_ks0108_powersave1_seq); |
| 170 | u8x8->cad_cb(u8x8, U8X8_MSG_CAD_END_TRANSFER, 0, NULL); |
| 171 | |
| 172 | } |
| 173 | break; |
| 174 | // The KS0108 can not mirror the cols and rows, use U8g2 for rotation |
| 175 | // case U8X8_MSG_DISPLAY_SET_FLIP_MODE: |
| 176 | // break; |
| 177 | // The KS0108 has no internal contrast command |
| 178 | // case U8X8_MSG_DISPLAY_SET_CONTRAST: |
| 179 | // break; |
| 180 | case U8X8_MSG_DISPLAY_DRAW_TILE: |
| 181 | |
| 182 | v.ptr = ((u8x8_tile_t *)arg_ptr)->tile_ptr; |
| 183 | v.x = ((u8x8_tile_t *)arg_ptr)->x_pos; |
| 184 | v.c = ((u8x8_tile_t *)arg_ptr)->cnt; |
| 185 | v.arg_int = arg_int; |
| 186 | |
| 187 | |
| 188 | if ( v.x < 8 ) |
| 189 | { |
| 190 | u8x8->cad_cb(u8x8, U8X8_MSG_CAD_START_TRANSFER, 1, NULL); |
| 191 | u8x8_ks0108_out(u8x8, &v, arg_ptr); |
| 192 | u8x8->cad_cb(u8x8, U8X8_MSG_CAD_END_TRANSFER, 0, NULL); |
| 193 | } |
| 194 | if ( v.x < 16 ) |
| 195 | { |
| 196 | u8x8->cad_cb(u8x8, U8X8_MSG_CAD_START_TRANSFER, 2, NULL); |
| 197 | u8x8_ks0108_out(u8x8, &v, arg_ptr); |
| 198 | u8x8->cad_cb(u8x8, U8X8_MSG_CAD_END_TRANSFER, 0, NULL); |
| 199 | } |
| 200 | //if ( v.x < 24 ) |
| 201 | //{ |
| 202 | //u8x8->cad_cb(u8x8, U8X8_MSG_CAD_START_TRANSFER, 4, NULL); |
| 203 | //u8x8_ks0108_out(u8x8, &v, arg_ptr); |
| 204 | //u8x8->cad_cb(u8x8, U8X8_MSG_CAD_END_TRANSFER, 0, NULL); |
| 205 | //} |
| 206 | break; |
| 207 | default: |
| 208 | return 0; |
| 209 | } |
| 210 | return 1; |
| 211 | } |
| 212 | |
| 213 | static const u8x8_display_info_t u8x8_ks0108_192x64_display_info = |
| 214 | { |
| 215 | /* chip_enable_level = */ 0, /* KS0108: Not used */ |
| 216 | /* chip_disable_level = */ 1, /* KS0108: Not used */ |
| 217 | |
| 218 | /* post_chip_enable_wait_ns = */ 100, |
| 219 | /* pre_chip_disable_wait_ns = */ 20, |
| 220 | /* reset_pulse_width_ms = */ 5, |
| 221 | /* post_reset_wait_ms = */ 6, /* could be faster for the KS0108 */ |
| 222 | /* sda_setup_time_ns = */ 12, |
| 223 | /* sck_pulse_width_ns = */ 75, /* KS0108: Not used */ |
| 224 | /* sck_clock_hz = */ 4000000UL, /* KS0108: Not used */ |
| 225 | /* spi_mode = */ 0, /* active high, rising edge */ |
| 226 | /* i2c_bus_clock_100kHz = */ 4, /* KS0108: Not used */ |
| 227 | /* data_setup_time_ns = */ 200, |
| 228 | /* write_pulse_width_ns = */ 250, /* KS0108: actially 450 ns, but additional 200 ns are added by the byte transfer function */ |
| 229 | /* tile_width = */ 24, /* width of 24*8=192 pixel */ |
| 230 | /* tile_height = */ 8, |
| 231 | /* default_x_offset = */ 0, |
| 232 | /* flipmode_x_offset = */ 0, |
| 233 | /* pixel_width = */ 192, |
| 234 | /* pixel_height = */ 64 |
| 235 | }; |
| 236 | |
| 237 | |
| 238 | /* east rising (buydisplay.com) ERM19264 */ |
| 239 | /* left: 011, middle: 101, right: 110, no chip select: 111 */ |
| 240 | uint8_t u8x8_d_ks0108_erm19264(u8x8_t *u8x8, uint8_t msg, uint8_t arg_int, void *arg_ptr) |
| 241 | { |
| 242 | struct u8x8_ks0108_vars v; |
| 243 | switch(msg) |
| 244 | { |
| 245 | case U8X8_MSG_DISPLAY_SETUP_MEMORY: |
| 246 | u8x8_d_helper_display_setup_memory(u8x8, &u8x8_ks0108_192x64_display_info); |
| 247 | break; |
| 248 | case U8X8_MSG_DISPLAY_INIT: |
| 249 | u8x8_d_helper_display_init(u8x8); |
| 250 | |
| 251 | u8x8->cad_cb(u8x8, U8X8_MSG_CAD_START_TRANSFER, 3, NULL); |
| 252 | u8x8_cad_SendSequence(u8x8, u8x8_d_ks0108_init_seq); |
| 253 | u8x8->cad_cb(u8x8, U8X8_MSG_CAD_END_TRANSFER, 7, NULL); |
| 254 | |
| 255 | u8x8->cad_cb(u8x8, U8X8_MSG_CAD_START_TRANSFER, 5, NULL); |
| 256 | u8x8_cad_SendSequence(u8x8, u8x8_d_ks0108_init_seq); |
| 257 | u8x8->cad_cb(u8x8, U8X8_MSG_CAD_END_TRANSFER, 7, NULL); |
| 258 | |
| 259 | u8x8->cad_cb(u8x8, U8X8_MSG_CAD_START_TRANSFER, 6, NULL); |
| 260 | u8x8_cad_SendSequence(u8x8, u8x8_d_ks0108_init_seq); |
| 261 | u8x8->cad_cb(u8x8, U8X8_MSG_CAD_END_TRANSFER, 7, NULL); |
| 262 | break; |
| 263 | case U8X8_MSG_DISPLAY_SET_POWER_SAVE: |
| 264 | |
| 265 | if ( arg_int == 0 ) |
| 266 | { |
| 267 | u8x8->cad_cb(u8x8, U8X8_MSG_CAD_START_TRANSFER, 3, NULL); |
| 268 | u8x8_cad_SendSequence(u8x8, u8x8_d_ks0108_powersave0_seq); |
| 269 | u8x8->cad_cb(u8x8, U8X8_MSG_CAD_END_TRANSFER, 7, NULL); |
| 270 | |
| 271 | u8x8->cad_cb(u8x8, U8X8_MSG_CAD_START_TRANSFER, 5, NULL); |
| 272 | u8x8_cad_SendSequence(u8x8, u8x8_d_ks0108_powersave0_seq); |
| 273 | u8x8->cad_cb(u8x8, U8X8_MSG_CAD_END_TRANSFER, 7, NULL); |
| 274 | |
| 275 | u8x8->cad_cb(u8x8, U8X8_MSG_CAD_START_TRANSFER, 6, NULL); |
| 276 | u8x8_cad_SendSequence(u8x8, u8x8_d_ks0108_powersave0_seq); |
| 277 | u8x8->cad_cb(u8x8, U8X8_MSG_CAD_END_TRANSFER, 7, NULL); |
| 278 | |
| 279 | } |
| 280 | else |
| 281 | { |
| 282 | u8x8->cad_cb(u8x8, U8X8_MSG_CAD_START_TRANSFER, 3, NULL); |
| 283 | u8x8_cad_SendSequence(u8x8, u8x8_d_ks0108_powersave1_seq); |
| 284 | u8x8->cad_cb(u8x8, U8X8_MSG_CAD_END_TRANSFER, 7, NULL); |
| 285 | |
| 286 | u8x8->cad_cb(u8x8, U8X8_MSG_CAD_START_TRANSFER, 5, NULL); |
| 287 | u8x8_cad_SendSequence(u8x8, u8x8_d_ks0108_powersave1_seq); |
| 288 | u8x8->cad_cb(u8x8, U8X8_MSG_CAD_END_TRANSFER, 7, NULL); |
| 289 | |
| 290 | u8x8->cad_cb(u8x8, U8X8_MSG_CAD_START_TRANSFER, 6, NULL); |
| 291 | u8x8_cad_SendSequence(u8x8, u8x8_d_ks0108_powersave1_seq); |
| 292 | u8x8->cad_cb(u8x8, U8X8_MSG_CAD_END_TRANSFER, 7, NULL); |
| 293 | |
| 294 | } |
| 295 | break; |
| 296 | // The KS0108 can not mirror the cols and rows, use U8g2 for rotation |
| 297 | // case U8X8_MSG_DISPLAY_SET_FLIP_MODE: |
| 298 | // break; |
| 299 | // The KS0108 has no internal contrast command |
| 300 | // case U8X8_MSG_DISPLAY_SET_CONTRAST: |
| 301 | // break; |
| 302 | case U8X8_MSG_DISPLAY_DRAW_TILE: |
| 303 | |
| 304 | v.ptr = ((u8x8_tile_t *)arg_ptr)->tile_ptr; |
| 305 | v.x = ((u8x8_tile_t *)arg_ptr)->x_pos; |
| 306 | v.c = ((u8x8_tile_t *)arg_ptr)->cnt; |
| 307 | v.arg_int = arg_int; |
| 308 | |
| 309 | /* |
| 310 | 3-bit CS value: |
| 311 | In u8x8_byte_set_ks0108_cs(u8x8_t *u8x8, uint8_t arg) the lowest |
| 312 | bit is assigned to CS and highest bit if the 3-bit value to CS2 |
| 313 | |
| 314 | CS: left part of the display --> 6 |
| 315 | CS1: middle part --> 5 |
| 316 | CS2: right part of the display --> 3 |
| 317 | |
| 318 | Reference: https://github.com/olikraus/u8g2/issues/631 |
| 319 | */ |
| 320 | if ( v.x < 8 ) |
| 321 | { |
| 322 | u8x8->cad_cb(u8x8, U8X8_MSG_CAD_START_TRANSFER, 6, NULL); // 3-->6, issue 631 |
| 323 | u8x8_ks0108_out(u8x8, &v, arg_ptr); |
| 324 | u8x8->cad_cb(u8x8, U8X8_MSG_CAD_END_TRANSFER, 7, NULL); |
| 325 | } |
| 326 | if ( v.x < 16 ) |
| 327 | { |
| 328 | u8x8->cad_cb(u8x8, U8X8_MSG_CAD_START_TRANSFER, 5, NULL); |
| 329 | u8x8_ks0108_out(u8x8, &v, arg_ptr); |
| 330 | u8x8->cad_cb(u8x8, U8X8_MSG_CAD_END_TRANSFER, 7, NULL); |
| 331 | } |
| 332 | if ( v.x < 24 ) |
| 333 | { |
| 334 | u8x8->cad_cb(u8x8, U8X8_MSG_CAD_START_TRANSFER, 3, NULL); // 6-->3, // issue 631 |
| 335 | u8x8_ks0108_out(u8x8, &v, arg_ptr); |
| 336 | u8x8->cad_cb(u8x8, U8X8_MSG_CAD_END_TRANSFER, 7, NULL); |
| 337 | } |
| 338 | break; |
| 339 | default: |
| 340 | return 0; |
| 341 | } |
| 342 | return 1; |
| 343 | } |
| 344 | |