starting point for LCD info

Author: logicplace

README.md

@@ -48,9 +48,9 @@ This is the repo for the Pokémon mini documentation hosted [here](https://www.p
     - Interrupts
     - Oscillators & Timers
     - I/O ports & protocols ?
-    - LCD Driver / PRC
+    - LCD Controller / PRC
     - Statuses (SLEEP/HALT)
-  - LCD: SED1565* (display driver)
+  - LCD: S1D15605* (display driver)
     - on this page:
       - Tech specs
         - dimensions
@@ -171,6 +171,5 @@ This is the repo for the Pokémon mini documentation hosted [here](https://www.p
         - Find the main loop
         - Understanding the RAM locations (and using BPs)
         - Using the debug output system
-        - Challenge: that CTF someone made, with spoilers
     - .minc format ?
 

hardware/README.md

@@ -15,7 +15,7 @@ The machine has a 4 KiB internal mask ROM (BIOS), 4 KiB of internal RAM (shared
   - [Audio / Sound](cpu/Sound.md)
   - [LCD Controller](cpu/LCD_Controller.md)
   - [Standby modes](cpu/Standby.md)
-- [LCD: SED15xx](LCD.md)
+- [LCD: S1D15xxx](LCD.md)
 - [EEPROM: 24xx64 alike](EEPROM.md)
 - [IR Transceiver](IR.md)
 - [Piezo Speaker](Speaker.md)

hardware/lcd/README.md

@@ -0,0 +1,192 @@
+# LCD and LCD Driver
+
+## LCD screen
+
+* Dimensions:
+  * Glass: 35mm x 32mm\* x 2mm
+    * \* ~7mm of the top is for the driver chip and FPC connection and otherwise "empty" glass
+  * Display area: approx. 28mm x 19.5mm
+  * Reflector panel: approx. 34.8mm x 24.7mm
+* Pixels: 96 x 64
+* Markings on glass (display side):
+  * Upper left: `A` centered over `F11`
+  * Upper right: `7680`
+  * A `+` on either side
+  * Dots around where the FPC connects with lines above them that match to etched lines on the FPC
+* Marking on FPC: `1012-90`
+
+Taped to the plastic front with clear, double-sided 3 mm wide tape in a hollow rectangle shape, the rectangle being approx. 35.4mm x 27.6mm on the outside
+
+The reflector is taped to the board with approx. 28mm (l) x 4mm (w) x 3.6mm (h) black foam tape
+
+## S1D15xxx LCD driver
+
+[S1D15000 Series Technical Manual](https://www.crystalfontz.com/controllers/uploaded/Epson%20S1D15605_SED1565_577706%20Tech%20Manual%20v1.1.pdf)
+
+* Part number: S1D15605?xxxx??
+  * S1 - Seiko Epson, previously SE
+  * D - Model name: Driver
+  * 15605 - Model number
+  * ? - Shape (unknown)
+  * xxxx - Specifications (unknown)
+  * ?? - Packing specification (unknown)
+* Supply voltage range: 1.8 to 5.5 V
+* LCD voltage range: 4.5 to 16 V
+* Duty: 1/65 (1/7, 1/9 bias)
+* Segments: 132
+* Commons: 65
+* Display RAM: 132x65 = 8580 bits
+* Microprocessor interface: 8-bit parallel
+* Frequency: 33 KHz
+* Package: Chip on Glass (COG)
+* Built-in power circuit for LCD (DC/DCx4)
+
+The driver runs in parallel mode (P/S = HIGH), master operation (M/S = HIGH), with the internal oscillator circuit disabled (C/S = LOW). Thus the CL line takes input from the MCU via OSC1 and the FR line switching resets register $8A to 1 and increases $81's frame counter by 1 (see page 8-29 for a diagram).
+
+### Commands
+
+To simplify interaction with the LCD, try [libpmdd](https://github.com/logicplace/libpmdd) instead of direct access.
+
+LCD_CTRL is primarily used for sending commands to the LCD driver and is accessible through register $FE on the PM.
+
+LCD_DATA is primarily used for sending display data to the LCD driver and is accessible through register $FF on the PM.
+
+LCD_CTRL and LCD_DATA both write and read over the D0-D7 lines, it determines what operation is happening and whether CTRL or DATA is being read/written by the status of the A0, <u style="text-decoration:overline">RD</u>, & <u style="text-decoration:overline">WR</u> lines.
+
+| A0 | <u style="text-decoration:overline">RD</u> | <u style="text-decoration:overline">WR</u> | R/W | CTRL/DATA |
+|---|---|---| ----- | ---- |
+| 0 | 0 | 1 | Read  | CTRL |
+| 0 | 1 | 0 | Write | CTRL |
+| 1 | 0 | 1 | Read  | DATA |
+| 1 | 1 | 0 | Write | DATA |
+
+#### Command list
+
+Listed below are the commands, written to CTRL.
+
+| Cmd #     | Command            | Command Code    | Hex range |
+|----------:| ------------------ | --------------- | --------- |
+| [1][]     | Display ON/OFF     | 1 0 1 0 1 1 1 x | $AE - $AF |
+| [2][]     | Display start line | 0 1 a a a a a a | $40 - $7F |
+| [3][]     | Set Page           | 1 0 1 1 a a a a | $B0 - $BF |
+| [4a][4]   | Set Column HI      | 0 0 0 1 h h h h | $10 - $1F |
+| [4b][4]   | Set Column LO      | 0 0 0 0 l l l l | $00 - $0F |
+| [8][]     | ADC select         | 1 0 1 0 0 0 0 x | $A0 - $A1 |
+| [9][]     | Invert             | 1 0 1 0 0 1 1 x | $A6 - $A7 |
+| [10][]    | All on             | 1 0 1 0 0 1 0 x | $A4 - $A5 |
+| [11][]    | LCD bias           | 1 0 1 0 0 0 1 x | $A2 - $A3 |
+| [12][]    | Start RMW          | 1 1 1 0 0 0 0 0 | $E0       |
+| [13][12]  | End RMW            | 1 1 1 0 1 1 1 0 | $EE       |
+| [14][]    | Reset              | 1 1 1 0 0 0 1 0 | $E2       |
+| [15][]    | Row direction      | 1 1 0 0 x - - - | $C0 - $CF |
+| [16][]    | Power control      | 0 0 1 0 1 m m m | $28 - $2F |
+| [17][]    | V5 resistor ratio  | 0 0 1 0 0 r r r | $20 - $27 |
+| [18a][18] | Contrast           | 1 0 0 0 0 0 0 1 | $81       |
+| [18b][18] | Contrast           | - - v v v v v v | $00 - $FF |
+| [19a][19] | Static indicator   | 1 0 1 0 1 1 0 x | $AC - $AD |
+| [19b][19] | Static indicator   | - - - - - - m m | $00 - $FF |
+| [20][]    | Power saver        |                 |           |
+| [21][]    | NOP                | 1 1 1 0 0 0 1 1 | $E3       |
+| [22][]    | Test               | 1 1 1 1 - - - - | $F0 - $FF |
+
+[1]: cmd/1.md
+[2]: cmd/2.md
+[3]: cmd/3.md
+[4]: cmd/4.md
+[5]: cmd/5.md
+[6]: cmd/6.md
+[7]: cmd/7.md
+[8]: cmd/8.md
+[9]: cmd/9.md
+[10]: cmd/10.md
+[11]: cmd/11.md
+[12]: cmd/12.md
+[14]: cmd/14.md
+[15]: cmd/15.md
+[16]: cmd/16.md
+[17]: cmd/17.md
+[18]: cmd/18.md
+[19]: cmd/19.md
+[20]: cmd/20.md
+[21]: cmd/21.md
+[22]: cmd/22.md
+
+#### Writing to display RAM
+
+Writes the byte to display RAM at the current cursor location then increments the cursor by 1. When the cursor reaches the end of the current page, it *does not* wrap around to the next page, you must do this manually.
+
+The data sent is displayed in a column of the current page formed as 0bABCDEFGH being (when rows are...)
+
+| Normal | Reversed |
+|:------:|:--------:|
+|   H    |    A     |
+|   G    |    B     |
+|   F    |    C     |
+|   E    |    D     |
+|   D    |    E     |
+|   C    |    F     |
+|   B    |    G     |
+|   A    |    H     |
+
+Then moves one column to the right (if ADC is normal) or left (if ADC is reversed).
+
+#### Reading display RAM
+
+TODO: how to read reliably
+
+Reading from LCD_DATA reads the byte in display RAM where the cursor is currently. If the driver is currently operating in RMW mode, the cursor is not incremented after reading. Otherwise, it is incremented.
+
+TODO: does ADC reverse reading direction?
+
+#### Reading display status
+
+Read from LCD_CTRL. TODO: how to read reliably
+
+The returned byte contains status information in the upper nibble:
+
+* D7 - BUSY - 1 = busy, 0 = not busy
+  * "Busy" means doing some sort of internal process or reset, during which it cannot accept commands.
+  * There's no need to check the busy signal.
+* D6 - ADC - 0 = reverse, 1 = normal
+  * This is opposite to the assignment command.
+  * The command $A0 will cause this status bit to be 1.
+  * The command $A1 will cause this status bit to be 0.
+* D5 - ON/OFF - 0 = ON 1 = OFF
+  * This is opposite to the assignment command.
+  * The command $AE will cause this status bit to be 0.
+  * The command $AF will cause this status bit to be 1.
+* D4 - RESET - 1 = reset in progress
+
+## FPC board connector pinout
+
+TODO: orientation
+
+1. VRS
+2. V5
+3. V4
+4. V3
+5. V2
+6. V1
+7. CAP2-
+8. CAP2+
+9. CAP1-
+10. CAP1+
+11. CAP3- (mislabled as CAP3+ in the block diagram)
+12. VOUT
+13. VSS (GND)
+14. VDD (VCC)
+15. D7
+16. D6
+17. D5
+18. D4
+19. D3
+20. D2
+21. D1
+22. D0
+23. <u style="text-decoration:overline">RD</u>
+24. <u style="text-decoration:overline">WR</u>
+25. A0
+26. <u style="text-decoration:overline">RES</u>
+27. CS
+28. CL
+29. FR

hardware/lcd/cmd/1.md

@@ -0,0 +1,20 @@
+# Display ON/OFF
+
+* To turn the display on, use:
+  * libpmdd: `LCD_PWR(ON);`
+  * C raw: `LCD_CTRL = 0xAF;`
+  * ASM: `LD LCD_CTRL, #0AFh`
+* To turn the display off, use:
+  * libpmdd: `LCD_PWR(OFF);`
+  * C raw: `LCD_CTRL = 0xAE;`
+  * ASM: `LD LCD_CTRL, #0AEh`
+* To turn the display on properly, use:
+  * C: `_int(0x56);`
+  * ASM: `INT [56h]`
+* To turn the display off properly, use:
+  * C: `_int(0x5A);`
+  * ASM: `INT [5Ah]`
+
+Note that sending [display all points](10.md) on ($A5) while the display is off, the display will enter [power saving mode](20.md).
+
+TODO: what is the power savings for turning the LCD off? without power savings mode

hardware/lcd/cmd/10.md

@@ -0,0 +1,18 @@
+# Display all points
+
+* To render normally, use:
+  * libpmdd: `LCD_SETALL(OFF);`
+  * C raw: `LCD_CTRL = 0xA4;`
+  * ASM: `LD LCD_CTRL, #0A4h`
+* To render all pixels as on, use:
+  * libpmdd: `LCD_SETALL(ON);`
+  * C raw: `LCD_CTRL = 0xA5;`
+  * ASM: `LD LCD_CTRL, #0A5h`
+
+This does not alter the contents of the display RAM.
+
+You can use this to create flashing effects. Combine with [invert](9.md) to flash white instead of black (TODO: confirm).
+
+If the display is off, sending setall on ($A5) will enable [power saving mode](20.md).
+
+When in standby mode, sending setall off ($A4) will cancel it. When in sleep mode, you must also send [static indicator on](19.md) to cancel it.

hardware/lcd/cmd/11.md

@@ -0,0 +1,14 @@
+# LCD bias set
+
+Don't mess with this as it could possibly damage the LCD.
+
+* To use 1/9 voltage bias, use:
+  * libpmdd: `LCD_VBIAS(NORMAL);`
+  * C raw: `LCD_CTRL = 0xA2;`
+  * ASM: `LD LCD_CTRL, #0A2h`
+* To to use 1/7 voltage bias, use:
+  * libpmdd: `LCD_VBIAS(DARK);`
+  * C raw: `LCD_CTRL = 0xA3;`
+  * ASM: `LD LCD_CTRL, #0A3h`
+
+Set to normal in the BIOS during LCD initialization [here](../../../software/bios/disasm/#user-content-089C).

hardware/lcd/cmd/12.md

@@ -0,0 +1,16 @@
+# Read/Modify/Write
+
+* To start RMW mode, use:
+  * libpmdd: `LCD_RMW(ON);`
+  * C raw: `LCD_CTRL = 0xE0;`
+  * ASM: `LD LCD_CTRL, #0E0h`
+* To stop RMW mode, use the end command via:
+  * libpmdd: `LCD_RMW(OFF);`
+  * C raw: `LCD_CTRL = 0xEE;`
+  * ASM: `LD LCD_CTRL, #0EEh`
+
+This mode causes the cursor to not increment when reading the display data. Conceptually, this could be used to blit new pixels atop the existing screen.
+
+When the end command is sent, the cursor returns to where it was when RMW began. Conceptually, this could be used to more quickly modify a section of the screen for an animation, such as a blinking cursor or decimal seconds digits on a clock.
+
+Because reading requires a dummy read, it may be appropriate to use this mode in order to read a single byte from the LCD without moving the cursor. If you intend to read multiple sequential bytes, though, you can do without it.

hardware/lcd/cmd/14.md

@@ -0,0 +1,21 @@
+# Reset
+
+* To reset the display/driver:
+  * libpmdd: `LCD_RESET();`
+  * C raw: `LCD_CTRL = 0xE2;`
+  * ASM: `LD LCD_CTRL, #0E2h`
+
+This resets all settings to the default state. It's essentially equivalent to running these in order:
+
+ * `LCD_RMW(OFF)` - releases the read/modify/write mode
+ * `LCD_STATIC(0)` - resets the static indicator: (D1, D2) = (0, 0)
+ * `LCD_SHIFT(0)` - initializes the display start line
+ * `LCD_COL(0)` - resets the column address
+ * `LCD_PAGE(0)` - resets the page address
+ * `LCD_ROW(NORMAL)` - resets the common output mode
+ * resets the V5 voltage regulator internal resistor ratio
+   * default unknown
+ * `LCD_CONTRAST(32)` - resets the electronic volume
+ * `LCD_NOP()` - releases the test mode
+
+ 

hardware/lcd/cmd/15.md

@@ -0,0 +1,32 @@
+# Common output mode select
+
+* To display rows top to bottom, use:
+  * libpmdd: `LCD_ROW(NORMAL);`
+  * C raw: `LCD_CTRL = 0xC0;`
+  * ASM: `LD LCD_CTRL, #0C0h`
+* To display rows bottom to top, use:
+  * libpmdd: `LCD_ROW(REVERSE);`
+  * C raw: `LCD_CTRL = 0xC8;`
+  * ASM: `LD LCD_CTRL, #0C8h`
+
+The normal display for rows is:
+
+```
+Row 0
+Row 1
+...
+Row 62
+Row 63
+```
+
+But when `LCD_ROW(REVERSE);` is used then the rows are displayed as:
+
+```
+Row 63
+Row 62
+...
+Row 1
+Row 0
+```
+
+When combining row reverse with [changing the starting row](2.md), it shifts up instead, so that `LCD_SHIFT(1);` causes row 0 to be on top, followed by row 63. (TODO: confirm)

hardware/lcd/cmd/16.md

@@ -0,0 +1,26 @@
+# Power controller set
+
+Don't mess with this as it could possibly damage the LCD.
+
+* To change the power supply configuration, use:
+  * libpmdd: `LCD_PWR_CTL(x);`
+  * C raw: `LCD_CTRL = 0x28 | x;`
+  * ASM: `LD LCD_CTRL, #028h | x`
+
+In the above, x stores three bit flags 0bBVF:
+
+* B = Booster circuit
+* V = Voltage regulator circuit
+* F = Voltage follower (V/F) circuit
+
+The docs provide the following table on page 8-32 and warn that other combinations are not recommended:
+
+| Use Settings | D2 | D1 | D0 | B | V | F | External voltage input | Step-up voltage system terminal |
+| Only the internal power supply is used | 1 | 1 | 1 | O | O | O | VSS2 | Used |
+| Only the V regulator circuit and the V/F circuit are used | 0 | 1 | 1 | X | O | O | VOUT, VSS2 | Open |
+| Only the V/F circuit is used | 0 | 0 | 1 | X | X | O | V5, VSS2 | Open |
+| Only the external power supply is used | 0 | 0 | 0 | X | X | X | V1 to V5 | Open |
+
+In the BIOS, this is set to 0b111 when the [LCD is initialized](../../../software/bios/disasm/#user-content-08A4) and to 0b000 when the [LCD is turned off](../../../software/bios/disasm/#user-content-08E2).
+
+It's very possible that the other modes do nothing or may damage the console. (TODO: real messaging)