converter/pc98_usb/matrix.c

   1 /*
   2 Copyright 2012 Jun Wako <wakojun@gmail.com>
   3
   4 This program is free software: you can redistribute it and/or modify
   5 it under the terms of the GNU General Public License as published by
   6 the Free Software Foundation, either version 2 of the License, or
   7 (at your option) any later version.
   8
   9 This program is distributed in the hope that it will be useful,
  10 but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 GNU General Public License for more details.
  13
  14 You should have received a copy of the GNU General Public License
  15 along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16 */
  17
  18 #include <stdint.h>
  19 #include <stdbool.h>
  20 #include <avr/io.h>
  21 #include <util/delay.h>
  22 #include "print.h"
  23 #include "util.h"
  24 #include "matrix.h"
  25 #include "led.h"
  26 #include "debug.h"
  27 #include "protocol/serial.h"
  28
  29
  30 /*
  31  * Matrix Array usage:
  32  *
  33  * ROW: 16(4bits)
  34  * COL:  8(3bits)
  35  *
  36  *    8bit wide
  37  *   +---------+
  38  *  0|00 ... 07|
  39  *  1|08 ... 0F|
  40  *  :|   ...   |
  41  *  :|   ...   |
  42  *  E|70 ... 77|
  43  *  F|78 ... 7F|
  44  *   +---------+
  45  */
  46 static uint8_t matrix[MATRIX_ROWS];
  47 #define ROW(code)      ((code>>3)&0xF)
  48 #define COL(code)      (code&0x07)
  49
  50
  51 static void pc98_send(uint8_t data)
  52 {
  53     xprintf("s%02X ", data);
  54     PC98_RDY_PORT |= (1<<PC98_RDY_BIT);
  55     _delay_ms(1);
  56     serial_send(data);
  57     _delay_ms(1);
  58     PC98_RDY_PORT &= ~(1<<PC98_RDY_BIT);
  59 }
  60
  61 static int16_t pc98_wait_response(void)
  62 {
  63     int16_t code = -1;
  64     uint8_t timeout = 255;
  65     while (timeout-- && (code = serial_recv2()) == -1) _delay_ms(1);
  66
  67     // Keyboards require RDY pulse >=37us to send next data
  68     // https://archive.org/stream/PC9800TechnicalDataBookHARDWARE1993/PC-9800TechnicalDataBook_HARDWARE1993#page/n157
  69     PC98_RDY_PORT |=  (1<<PC98_RDY_BIT);
  70     _delay_us(40);
  71     PC98_RDY_PORT &= ~(1<<PC98_RDY_BIT);
  72
  73     xprintf("r%04X ", code);
  74     return code;
  75 }
  76
  77 static void pc98_inhibit_repeat(void)
  78 {
  79     uint16_t code;
  80 RETRY:
  81     pc98_send(0x9C);
  82     code = pc98_wait_response();
  83     if (code != -1) dprintf("send 9C: %02X\n", code);
  84     if (code != 0xFA) return;
  85
  86     pc98_send(0x70);
  87     code = pc98_wait_response();
  88     if (code != -1) dprintf("send 70: %02X\n", code);
  89     if (code != 0xFA) goto RETRY;
  90 }
  91
  92 static bool pc98_is_newtype(void)
  93 {
  94     uint16_t code;
  95     pc98_send(0x9F);
  96     code = pc98_wait_response();
  97     if (code != 0xFA) return false;
  98
  99     code = pc98_wait_response();
 100     if (code != 0xA0) return false;
 101
 102     code = pc98_wait_response();
 103     if (code != 0x80) return false;
 104
 105     return true;
 106 }
 107
 108 static uint8_t pc98_led = 0;
 109 static void pc98_led_set(void)
 110 {
 111     uint16_t code;
 112 RETRY:
 113     pc98_send(0x9D);
 114     code = pc98_wait_response();
 115     if (code != -1) dprintf("send 9D: %02X\n", code);
 116     if (code != 0xFA) return;
 117
 118     pc98_send(pc98_led);
 119     code = pc98_wait_response();
 120     if (code != -1) dprintf("send %02X: %02X\n", pc98_led, code);
 121     if (code != 0xFA) goto RETRY;
 122 }
 123
 124 void matrix_init(void)
 125 {
 126     PC98_RST_DDR |= (1<<PC98_RST_BIT);
 127     PC98_RDY_DDR |= (1<<PC98_RDY_BIT);
 128     PC98_RTY_DDR |= (1<<PC98_RTY_BIT);
 129     PC98_RST_PORT |= (1<<PC98_RST_BIT);
 130     PC98_RDY_PORT |= (1<<PC98_RDY_BIT);
 131     PC98_RTY_PORT |= (1<<PC98_RTY_BIT);
 132
 133
 134     serial_init();
 135
 136     // PC98 reset
 137     // https://archive.org/stream/PC9800TechnicalDataBookHARDWARE1993/PC-9800TechnicalDataBook_HARDWARE1993#page/n359
 138     PC98_RDY_PORT |=  (1<<PC98_RDY_BIT);    // RDY: high
 139     PC98_RST_PORT &= ~(1<<PC98_RST_BIT);    // RST: low
 140     _delay_us(15);                          // > 13us
 141     PC98_RST_PORT |= (1<<PC98_RST_BIT);     // RST: high
 142
 143     _delay_ms(50);
 144     if (pc98_is_newtype()) xprintf("new type\n"); else xprintf("old type\n");
 145     pc98_inhibit_repeat();
 146
 147     // initialize matrix state: all keys off
 148     for (uint8_t i=0; i < MATRIX_ROWS; i++) matrix[i] = 0x00;
 149
 150     // ready to receive from keyboard
 151     PC98_RDY_PORT &= ~(1<<PC98_RDY_BIT);    // RDY: low
 152
 153     return;
 154 }
 155
 156 uint8_t matrix_scan(void)
 157 {
 158     uint16_t code;
 159     code = serial_recv2();
 160     if (code == -1) {
 161 #ifdef PC98_LED_CONTROL
 162         // Before sending command  we have to make sure that there is no unprocessed key in queue
 163         // otherwise keys will be missed during sending command
 164         if (pc98_led) {
 165             pc98_led_set();
 166             pc98_led = 0;
 167         }
 168 #endif
 169         return 0;
 170     }
 171
 172     xprintf("r%02X ", code);
 173
 174     if (code&0x80) {
 175         // break code
 176         if (matrix_is_on(ROW(code), COL(code))) {
 177             matrix[ROW(code)] &= ~(1<<COL(code));
 178         }
 179     } else {
 180         // make code
 181         if (!matrix_is_on(ROW(code), COL(code))) {
 182             matrix[ROW(code)] |=  (1<<COL(code));
 183         }
 184     }
 185
 186     // Keyboards require RDY pulse >=37us to send next data
 187     // https://archive.org/stream/PC9800TechnicalDataBookHARDWARE1993/PC-9800TechnicalDataBook_HARDWARE1993#page/n157
 188     PC98_RDY_PORT |=  (1<<PC98_RDY_BIT);
 189     _delay_us(40);
 190     PC98_RDY_PORT &= ~(1<<PC98_RDY_BIT);
 191
 192     return code;
 193 }
 194
 195 inline
 196 uint8_t matrix_get_row(uint8_t row)
 197 {
 198     return matrix[row];
 199 }
 200
 201 void led_set(uint8_t usb_led)
 202 {
 203     // https://archive.org/stream/PC9800TechnicalDataBookHARDWARE1993/PC-9800TechnicalDataBook_HARDWARE1993#page/n161
 204     // http://www.webtech.co.jp/company/doc/undocumented_mem/io_kb.txt
 205     pc98_led = 0x70;
 206     if (usb_led & (1<<USB_LED_NUM_LOCK))    pc98_led |= (1<<0);
 207     if (usb_led & (1<<USB_LED_CAPS_LOCK))   pc98_led |= (1<<2);
 208     dprintf("usb_led: %02X\n", usb_led);
 209     dprintf("pc98_led: %02X\n", pc98_led);
 210 }