tmk_core/protocol/news.c

   1 /*
   2 Copyright 2012 Jun WAKO <wakojun@gmail.com>
   3
   4 This software is licensed with a Modified BSD License.
   5 All of this is supposed to be Free Software, Open Source, DFSG-free,
   6 GPL-compatible, and OK to use in both free and proprietary applications.
   7 Additions and corrections to this file are welcome.
   8
   9
  10 Redistribution and use in source and binary forms, with or without
  11 modification, are permitted provided that the following conditions are met:
  12
  13 * Redistributions of source code must retain the above copyright
  14   notice, this list of conditions and the following disclaimer.
  15
  16 * Redistributions in binary form must reproduce the above copyright
  17   notice, this list of conditions and the following disclaimer in
  18   the documentation and/or other materials provided with the
  19   distribution.
  20
  21 * Neither the name of the copyright holders nor the names of
  22   contributors may be used to endorse or promote products derived
  23   from this software without specific prior written permission.
  24
  25 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  26 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  27 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  28 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  29 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  30 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  31 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  32 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  33 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  34 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  35 POSSIBILITY OF SUCH DAMAGE.
  36 */
  37
  38 #include <stdbool.h>
  39 #include <avr/io.h>
  40 #include <avr/interrupt.h>
  41 #include "news.h"
  42
  43
  44 void news_init(void)
  45 {
  46     NEWS_KBD_RX_INIT();
  47 }
  48
  49 // RX ring buffer
  50 #define RBUF_SIZE   8
  51 static uint8_t rbuf[RBUF_SIZE];
  52 static uint8_t rbuf_head = 0;
  53 static uint8_t rbuf_tail = 0;
  54
  55 uint8_t news_recv(void)
  56 {
  57     uint8_t data = 0;
  58     if (rbuf_head == rbuf_tail) {
  59         return 0;
  60     }
  61
  62     data = rbuf[rbuf_tail];
  63     rbuf_tail = (rbuf_tail + 1) % RBUF_SIZE;
  64     return data;
  65 }
  66
  67 // USART RX complete interrupt
  68 ISR(NEWS_KBD_RX_VECT)
  69 {
  70     uint8_t next = (rbuf_head + 1) % RBUF_SIZE;
  71     if (next != rbuf_tail) {
  72         rbuf[rbuf_head] = NEWS_KBD_RX_DATA;
  73         rbuf_head = next;
  74     }
  75 }
  76
  77
  78 /*
  79 SONY NEWS Keyboard Protocol
  80 ===========================
  81
  82 Resources
  83 ---------
  84     Mouse protocol of NWA-5461(Japanese)
  85     http://groups.google.com/group/fj.sys.news/browse_thread/thread/a01b3e3ac6ae5b2d
  86
  87     SONY NEWS Info(Japanese)
  88     http://katsu.watanabe.name/doc/sonynews/
  89
  90
  91 Pinouts
  92 -------
  93     EIA 232 male connector from NWP-5461
  94     -------------
  95     \ 1 2 3 4 5 /
  96      \ 6 7 8 9 /
  97       ---------
  98     1 VCC
  99     2 BZ(Speaker)
 100     3 Keyboard Data(from keyboard MCU TxD)
 101     4 NC
 102     5 GND
 103     6 Unknown Input(to keyboard MCU RxD via schmitt trigger)
 104     7 Mouse Data(from Mouse Ext connector)
 105     8 Unknown Input(to Keyboard MCU Input via diode and buffer)
 106     9 FG
 107     NOTE: Two LED on keyboard are controlled by pin 6,8?
 108
 109     EIA 232 male connector from NWP-411A
 110     -------------
 111     \ 1 2 3 4 5 /
 112      \ 6 7 8 9 /
 113       ---------
 114     1 VCC
 115     2 BZ(Speaker)
 116     3 Keyboard Data(from keyboard MCU TxD)
 117     4 NC
 118     5 GND
 119     6 NC
 120     7 Mouse Data(from Mouse Ext connector)
 121     8 NC
 122     9 FG
 123     NOTE: These are just from my guess and not confirmed.
 124
 125
 126 Signaling
 127 ---------
 128     ~~~~~~~~~~ ____XOO0X111X222X333X444X555X666X777~~~~ ~~~~~~~
 129     Idle    Start  LSB                         MSB Stop Idle
 130
 131     Idle:       High
 132     Start bit:  Low
 133     Stop bit:   High
 134     Bit order:  LSB first
 135
 136     Baud rate:  9600
 137     Interface:  TTL level(5V) UART
 138
 139     NOTE: This is observed on NWP-5461 with its DIP switch all OFF.
 140
 141
 142 Format
 143 ------
 144     MSB         LSB
 145     7 6 5 4 3 2 1 0   bit
 146     | | | | | | | |
 147     | +-+-+-+-+-+-+-- scan code(00-7F)
 148     +---------------- break flag: sets when released
 149
 150
 151 Scan Codes
 152 ----------
 153     SONY NEWS NWP-5461
 154     ,---.   ,------------------------, ,------------------------. ,---------.
 155     | 7A|   | 01 | 02 | 03 | 04 | 05 | | 06 | 07 | 08 | 09 | 0A | | 68 | 69 | ,-----------.
 156     `---'   `------------------------' `------------------------' `---------' | 64| 65| 52|
 157     ,-------------------------------------------------------------. ,---. ,---------------|
 158     | 0B| 0C| 0D| 0E| 0F| 10| 11| 12| 13| 14| 15| 16| 17| 18|  19 | | 6A| | 4B| 4C| 4D| 4E|
 159     |-------------------------------------------------------------| |---| |---------------|
 160     |  1A | 1B| 1C| 1D| 1E| 1F| 20| 21| 22| 23| 24| 25| 26| 27|   | | 6B| | 4F| 50| 51| 56|
 161     |---------------------------------------------------------'   | |---| |---------------|
 162     |  28  | 29| 2A| 2B| 2C| 2D| 2E| 2F| 30| 31| 32| 33| 34|  35  | | 6C| | 53| 54| 55|   |
 163     |-------------------------------------------------------------| |---| |-----------| 5A|
 164     |  36    | 37| 38| 39| 3A| 3B| 3C| 3D| 3E| 3F| 40| 41|   42   | | 6D| | 57| 59| 58|   |
 165     |-------------------------------------------------------------| |---| |---------------|
 166     | 43  | 44 | 45 |       46          |    47    | 48| 49|  4A  | | 6E| | 66| 5B| 5C| 5D|
 167     `-------------------------------------------------------------' `---' `---------------'
 168 */