Difference between revisions of "84PCE:Ports:A000"

From WikiTI
Jump to: navigation, search
(Registers: Document mask register)
 
(12 intermediate revisions by 3 users not shown)
Line 7: Line 7:
 
'''Memory-mapped address:''' F50000-?
 
'''Memory-mapped address:''' F50000-?
  
'''Function:''' Keypad Controller options
+
'''Function:''' Keypad Controller
  
'''Using the keypad'''
+
== Registers ==
 +
* F50000 (R/W):
 +
** Bits 0-1: Scan mode
 +
*** Mode 0: Idle.
 +
*** Mode 1: Indiscriminate key detection. Data registers of all enabled rows are set to the bitwise OR of those rows, and whenever any key is pressed, interrupt bit 2 is set (and cannot be cleared until the key is released).
 +
*** Mode 2: Single scan. The keypad is scanned once, and then the mode returns to 0.
 +
*** Mode 3: Continuous scan. When scanning completes, it just starts over again after a delay.
 +
** Bits 2-15: Number of APB (6MHz) cycles to wait before scanning each row (default value is 03C0h; bits 2-7 are 0 so the mode can be written directly to F50000)
 +
** Bits 16-31: Number of APB (6MHz) cycles to wait between scans (default value is 0F00h)
 +
 
 +
* F50004 (R/W):
 +
** Bits 0-7: Number of rows to read (later rows are not updated in F50010-F5002F, and just read as whatever they were before being disabled)
 +
** Bits 8-15: Number of columns to read (later column bits in a row are set to 0 when it is updated)
 +
** Bits 16-31: Mask of rows to scan in mode 1. Rows corresponding to "1" bits are included in the scan. Strangely, this mask also determines which columns can set interrupt bit 2, despite not being masked out in the data registers.
 +
* F50008 (R/W): Keypad interrupt status/acknowledge (3-bit). Write "1" bits to acknowledge.
 +
** Bit 0: Keypad scan complete
 +
** Bit 1: Keypad data register changed
 +
** Bit 2: Key pressed in mode 1
 +
 
 +
* F5000C (R/W): Keypad interrupt mask (3-bit). Set each bit to 1 if the corresponding event in [F50008] should cause an interrupt.
 +
 
 +
* F50010-F5002F (R): Keypad data, one halfword per row.
 +
 
 +
* F50030-F5003F (R/W): Keypad GPIOs. Each register is 20 bits, with one bit per GPIO. The role of each register is unknown.
 +
 
 +
== Using the keypad ==
 
* This is the layout of what the keypad looks like according to the controller:
 
* This is the layout of what the keypad looks like according to the controller:
 
{|border="1" cellspacing="0" cellpadding="5"
 
{|border="1" cellspacing="0" cellpadding="5"
Line 22: Line 47:
 
! Bit 6
 
! Bit 6
 
! Bit 7
 
! Bit 7
! Bit 8
 
! Bit 9
 
! Bit 10
 
 
|-
 
|-
 
| F50010
 
| F50010
| bgcolor=lightgray |
 
| bgcolor=lightgray |
 
| bgcolor=lightgray |
 
 
| bgcolor=lightgray |
 
| bgcolor=lightgray |
 
| bgcolor=lightgray |
 
| bgcolor=lightgray |
Line 48: Line 67:
 
| mode
 
| mode
 
| del
 
| del
| bgcolor=lightgray |
 
| bgcolor=lightgray |
 
| bgcolor=lightgray |
 
 
|-
 
|-
 
| F50014
 
| F50014
| on
+
| bgcolor=lightgray |
 
| sto
 
| sto
 
| ln
 
| ln
Line 61: Line 77:
 
| math
 
| math
 
| alpha
 
| alpha
| bgcolor=lightgray |
 
| bgcolor=lightgray |
 
| bgcolor=lightgray |
 
 
|-
 
|-
 
| F50016
 
| F50016
Line 74: Line 87:
 
| apps
 
| apps
 
| X
 
| X
| bgcolor=lightgray |
 
| bgcolor=lightgray |
 
| bgcolor=lightgray |
 
 
|-
 
|-
 
| F50018
 
| F50018
Line 87: Line 97:
 
| prgm
 
| prgm
 
| stat
 
| stat
| bgcolor=lightgray |
 
| bgcolor=lightgray |
 
| bgcolor=lightgray |
 
 
|-
 
|-
 
| F5001A
 
| F5001A
Line 99: Line 106:
 
| tan
 
| tan
 
| vars
 
| vars
| bgcolor=lightgray |
 
| bgcolor=lightgray |
 
| bgcolor=lightgray |
 
 
| bgcolor=lightgray |
 
| bgcolor=lightgray |
 
|-
 
|-
Line 112: Line 116:
 
| ^
 
| ^
 
| clear
 
| clear
| bgcolor=lightgray |
 
| bgcolor=lightgray |
 
| bgcolor=lightgray |
 
 
| bgcolor=lightgray |
 
| bgcolor=lightgray |
 
|-
 
|-
Line 122: Line 123:
 
| right
 
| right
 
| up
 
| up
| bgcolor=lightgray |
 
| bgcolor=lightgray |
 
| bgcolor=lightgray |
 
 
| bgcolor=lightgray |
 
| bgcolor=lightgray |
 
| bgcolor=lightgray |
 
| bgcolor=lightgray |
Line 130: Line 128:
 
| bgcolor=lightgray |
 
| bgcolor=lightgray |
 
|}
 
|}
 +
* '''Note:''' Group F5001A Bit 0 is NEGATE, not to be confused with SUBTRACT.
 +
* '''Note:''' Group F50014 Bit 0 would be ON, but the ON key is tested elsewhere.
  
The controller works by scanning lines; not by selecting a row and column like previous versions.
+
The controller works by scanning multiple rows into data registers; rather than manually selecting rows like previous versions.
  
For example, if you set the controller to scan 3 lines, it will affect only the data in F00010h, F00012h, F00014h, and leave the others alone.
+
For example, if you set the controller to scan 3 rows, it will affect only the data in F00010h, F00012h, F00014h, and leave the others alone. There's not really a reason to set anything other than 8 rows, though.
  
You will want to disable interrupts when reading, as OS interrupts can cause garbage to be read.
+
You will want to disable interrupts when performing your own scans, as OS interrupts will modify the controller's state.
  
Before you exit your program, if you have modified the keypad controller in any way, it is '''crucial''' to restore the keypad controller back to its original state.
+
Alternatively, if you want to make use of the OS's scans, you will want to first check the scan mode to ensure the data registers are valid. The OS leaves the controller in mode 1 when no keys are pressed, which renders the data registers useless.
  
This is how TI does it (Not really; ports are used instead, but it's the same idea)
+
== Comments ==
<pre>RestoreKeyboard:
+
The CE appears to use the same keypad controller as the TI-Nspire series.
ld bc,0F50000h
+
xor a ; Mode 0
+
ld (bc),a
+
inc c ; 0F50001h
+
ld a,15 ; Wait 15 APB cycles before scanning each row
+
ld (bc),a
+
inc c ; 0F50002h
+
xor a
+
ld (bc),a
+
inc c ; 0F50003h
+
ld a,15 ; Wait 15 APB cycles before each scan
+
ld (bc),a
+
inc c ; 0F50004h
+
ld a,8 ; Number of rows to scan
+
ld (bc),a
+
inc c ; 0F50005h
+
ld (bc),a ; Number of columns to scan
+
ret</pre>
+
  
----
+
== Example ==
'''Controller Address Uses:'''
+
  
* F50000 (R/W):
+
=== Scanning the Keypad ===
** Bits 0-1: Scan mode
+
<nowiki> di            ; Disable OS interrupts
*** Mode 0: Idle.
+
ld hl,0F50000h
*** Mode 1: Indiscriminate key detection. Data registers are not updated, but whenever any key is pressed, interrupt bit 2 is set (and cannot be cleared until the key is released).
+
ld (hl),2     ; Set Single Scan mode
*** Mode 2: Single scan. The keypad is scanned once, and then the mode returns to 0.
+
*** Mode 3: Continuous scan. When scanning completes, it just starts over again after a delay.
+
** Bits 2-15: Number of APB cycles to wait before scanning each row
+
** Bits 16-31: Number of APB cycles to wait between scans
+
  
* F50004 (R/W):
+
xor a,a
** Bits 0-7: Number of rows to read (later rows are not updated in F50010-F5002F, and just read as whatever they were before being disabled)
+
scan_wait:
** Bits 8-15: Number of columns to read (later column bits in a row are set to 1 when it is updated)
+
cp a,(hl)     ; Wait for Idle mode
* F50008 (R/W): Keypad interrupt status/acknowledge (3-bit). Write "1" bits to acknowledge.
+
jr nz,scan_wait
** Bit 0: Keypad scan complete
+
** Bit 1: Keypad data register changed
+
** Bit 2: Key pressed in mode 1
+
  
* F5000C (R/W): Keypad interrupt mask (3-bit). Set each bit to 1 if the corresponding event in [F50008] should cause an interrupt.
+
; Read data registers here as needed
  
* F50010-F5002F (R): Keypad data, one halfword per row.
+
ei            ; Enable OS interrupts</nowiki>
  
* F50030-F5003F (R/W): Keypad GPIOs. Each register is 20 bits, with one bit per GPIO. The role of each register is unknown.
+
It is generally a good idea to reset the keypad controller back before exiting your program, in case you have modified timings and such.
  
NOTE: The CE appears to use the same keypad controller as the nSpire CX.
+
=== Reset the Keypad ===
 +
<nowiki>RestoreKeyboard:
 +
ld hl,0F50000h
 +
xor a ; Mode 0
 +
ld (hl),a
 +
inc l ; 0F50001h
 +
ld (hl),15 ; Wait 15*256 APB cycles before scanning each row
 +
inc l ; 0F50002h
 +
xor a
 +
ld (hl),a
 +
inc l ; 0F50003h
 +
ld (hl),15 ; Wait 15 APB cycles before each scan
 +
inc l ; 0F50004h
 +
ld a,8 ; Number of rows to scan
 +
ld (hl),a
 +
inc l ; 0F50005h
 +
ld (hl),a ; Number of columns to scan
 +
ret</nowiki>

Latest revision as of 10:02, 21 September 2024

Synopsis

Port Number: A000-?

Memory-mapped address: F50000-?

Function: Keypad Controller

Registers

  • F50000 (R/W):
    • Bits 0-1: Scan mode
      • Mode 0: Idle.
      • Mode 1: Indiscriminate key detection. Data registers of all enabled rows are set to the bitwise OR of those rows, and whenever any key is pressed, interrupt bit 2 is set (and cannot be cleared until the key is released).
      • Mode 2: Single scan. The keypad is scanned once, and then the mode returns to 0.
      • Mode 3: Continuous scan. When scanning completes, it just starts over again after a delay.
    • Bits 2-15: Number of APB (6MHz) cycles to wait before scanning each row (default value is 03C0h; bits 2-7 are 0 so the mode can be written directly to F50000)
    • Bits 16-31: Number of APB (6MHz) cycles to wait between scans (default value is 0F00h)
  • F50004 (R/W):
    • Bits 0-7: Number of rows to read (later rows are not updated in F50010-F5002F, and just read as whatever they were before being disabled)
    • Bits 8-15: Number of columns to read (later column bits in a row are set to 0 when it is updated)
    • Bits 16-31: Mask of rows to scan in mode 1. Rows corresponding to "1" bits are included in the scan. Strangely, this mask also determines which columns can set interrupt bit 2, despite not being masked out in the data registers.
  • F50008 (R/W): Keypad interrupt status/acknowledge (3-bit). Write "1" bits to acknowledge.
    • Bit 0: Keypad scan complete
    • Bit 1: Keypad data register changed
    • Bit 2: Key pressed in mode 1
  • F5000C (R/W): Keypad interrupt mask (3-bit). Set each bit to 1 if the corresponding event in [F50008] should cause an interrupt.
  • F50010-F5002F (R): Keypad data, one halfword per row.
  • F50030-F5003F (R/W): Keypad GPIOs. Each register is 20 bits, with one bit per GPIO. The role of each register is unknown.

Using the keypad

  • This is the layout of what the keypad looks like according to the controller:
Address Bit 0 Bit 1 Bit 2 Bit 3 Bit 4 Bit 5 Bit 6 Bit 7
F50010
F50012 graph trace zoom wind y= 2nd mode del
F50014 sto ln log x^2 x^-1 math alpha
F50016 0 1 4 7 , sin apps X
F50018 . 2 5 8 ( cos prgm stat
F5001A (-) 3 6 9 ) tan vars
F5001C enter + - * / ^ clear
F5001E down left right up
  • Note: Group F5001A Bit 0 is NEGATE, not to be confused with SUBTRACT.
  • Note: Group F50014 Bit 0 would be ON, but the ON key is tested elsewhere.

The controller works by scanning multiple rows into data registers; rather than manually selecting rows like previous versions.

For example, if you set the controller to scan 3 rows, it will affect only the data in F00010h, F00012h, F00014h, and leave the others alone. There's not really a reason to set anything other than 8 rows, though.

You will want to disable interrupts when performing your own scans, as OS interrupts will modify the controller's state.

Alternatively, if you want to make use of the OS's scans, you will want to first check the scan mode to ensure the data registers are valid. The OS leaves the controller in mode 1 when no keys are pressed, which renders the data registers useless.

Comments

The CE appears to use the same keypad controller as the TI-Nspire series.

Example

Scanning the Keypad

 di             ; Disable OS interrupts
 ld hl,0F50000h
 ld (hl),2      ; Set Single Scan mode

 xor a,a
scan_wait:
 cp a,(hl)      ; Wait for Idle mode
 jr nz,scan_wait

 ; Read data registers here as needed

 ei             ; Enable OS interrupts

It is generally a good idea to reset the keypad controller back before exiting your program, in case you have modified timings and such.

Reset the Keypad

RestoreKeyboard:
 ld hl,0F50000h
 xor a		; Mode 0
 ld (hl),a
 inc l		; 0F50001h
 ld (hl),15	; Wait 15*256 APB cycles before scanning each row
 inc l		; 0F50002h
 xor a
 ld (hl),a
 inc l		; 0F50003h
 ld (hl),15	; Wait 15 APB cycles before each scan
 inc l		; 0F50004h
 ld a,8		; Number of rows to scan
 ld (hl),a
 inc l		; 0F50005h
 ld (hl),a	; Number of columns to scan
 ret