mirror of
https://github.com/osiweb/unified_retro_keyboard.git
synced 2024-09-27 19:57:04 +00:00
299 lines
17 KiB
C
299 lines
17 KiB
C
|
// -*- mode: C; tab-width: 4 ; indent-tabs-mode: nil -*-
|
||
|
//
|
||
|
// Unfified Keyboard Project
|
||
|
// ASDF keyboard firmware
|
||
|
//
|
||
|
// asdf_keymap_apple2.h
|
||
|
//
|
||
|
// Apple 2 keymaps
|
||
|
//
|
||
|
// Copyright 2019 David Fenyes
|
||
|
//
|
||
|
// This program is free software: you can redistribute it and/or modify it under
|
||
|
// the terms of the GNU General Public License as published by the Free Software
|
||
|
// Foundation, either version 3 of the License, or (at your option) any later
|
||
|
// version.
|
||
|
//
|
||
|
// This program is distributed in the hope that it will be useful, but WITHOUT
|
||
|
// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
|
||
|
// FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
|
||
|
// details.
|
||
|
//
|
||
|
// You should have received a copy of the GNU General Public License along with
|
||
|
// this program. If not, see <https://www.gnu.org/licenses/>.
|
||
|
|
||
|
|
||
|
// This file supplies the Apple 2 ASCII keyboard keymap. Two variants are provided:
|
||
|
//
|
||
|
// 1) An Upper/Lowercase variant. This variant moves the @ and ^ symbols from
|
||
|
// the P and N keys to the REPEAT key, since the P and N keys need to reserve
|
||
|
// the shifted value for the uppercase characters. Also, the "Power" key
|
||
|
// doubles as a caps-lock key.
|
||
|
//
|
||
|
// 2) A CAPS only keyboard, following the standard Apple II conventions and
|
||
|
// layout, with ^ above the N key and @ above the P key, and a functioning
|
||
|
// REPEAT key.
|
||
|
//
|
||
|
// For both variants, CTRL+RESET is required for a system reset.
|
||
|
|
||
|
#if !defined(ASDF_KEYMAP_DEFS_APPLE2_H)
|
||
|
#define ASDF_KEYMAP_DEFS_APPLE2_H
|
||
|
|
||
|
// Edit the number of rows and columns used in this map. If the number is less
|
||
|
// than the maxium, the unused elements will be initialized to 0.
|
||
|
|
||
|
#define ASDF_APPLE2_NUM_ROWS 9 // DIP switches are row 8 (zero-based)
|
||
|
#define ASDF_APPLE2_NUM_COLS 8
|
||
|
|
||
|
#define APPLE_ACTION_RESET ACTION_VOUT1
|
||
|
#define APPLE_VIRTUAL_RESET VOUT1
|
||
|
#define APPLE_RESET_OUTPUT PHYSICAL_OUT3_OPEN_HI
|
||
|
#define APPLE_RESET_ACTIVE_VALUE 0
|
||
|
|
||
|
#define APPLE_ACTION_CLEAR ACTION_VOUT2
|
||
|
#define APPLE_VIRTUAL_CLR_SCR VOUT2
|
||
|
#define APPLE_CLR_SCR_OUTPUT PHYSICAL_OUT1_OPEN_LO
|
||
|
#define APPLE_CLR_SCR_ACTIVE_VALUE 1
|
||
|
|
||
|
#define APPLE_VIRTUAL_POWER_LED VLED1
|
||
|
#define APPLE_POWER_LED PHYSICAL_LED1
|
||
|
#define APPLE_POWER_LED_INIT_VALUE 1
|
||
|
|
||
|
#define APPLE_VIRTUAL_DISABLED_LED VLED2
|
||
|
#define APPLE_DISABLED_LED PHYSICAL_LED3
|
||
|
#define APPLE_DISABLED_INIT_VALUE 0
|
||
|
|
||
|
// The PLAIN map uses the "power" button as a caps-lock, so map the CAPS LED to
|
||
|
// the power button LED.
|
||
|
#define ASDF_APPLE2_PLAIN_KEYMAP_INITIALIZER \
|
||
|
{ \
|
||
|
{ .virtual_device = VCAPS_LED, .physical_device = APPLE_POWER_LED, .initial_value = 0 }, \
|
||
|
{ .virtual_device = APPLE_VIRTUAL_DISABLED_LED, \
|
||
|
.physical_device = APPLE_DISABLED_LED, \
|
||
|
.initial_value = 0 }, \
|
||
|
{ .virtual_device = APPLE_VIRTUAL_RESET, \
|
||
|
.physical_device = APPLE_RESET_OUTPUT, \
|
||
|
.function = V_PULSE_SHORT, \
|
||
|
.initial_value = !APPLE_RESET_ACTIVE_VALUE }, \
|
||
|
{ \
|
||
|
.virtual_device = APPLE_VIRTUAL_CLR_SCR, .physical_device = APPLE_CLR_SCR_OUTPUT, \
|
||
|
.function = V_PULSE_LONG, .initial_value = !APPLE_CLR_SCR_ACTIVE_VALUE \
|
||
|
} \
|
||
|
}
|
||
|
|
||
|
// The ALL CAPS map is the classic Apple II/II+ map. There is no CAPS LED, since
|
||
|
// CAPS doesn't matter in the ALL CAPS keymap.
|
||
|
#define ASDF_APPLE2_CAPS_KEYMAP_INITIALIZER \
|
||
|
{ \
|
||
|
{ .virtual_device = APPLE_VIRTUAL_POWER_LED, \
|
||
|
.physical_device = APPLE_POWER_LED, \
|
||
|
.initial_value = APPLE_POWER_LED_INIT_VALUE }, \
|
||
|
{ .virtual_device = APPLE_VIRTUAL_DISABLED_LED, \
|
||
|
.physical_device = APPLE_DISABLED_LED, \
|
||
|
.initial_value = 0 }, \
|
||
|
{ .virtual_device = APPLE_VIRTUAL_RESET, \
|
||
|
.physical_device = APPLE_RESET_OUTPUT, \
|
||
|
.function = V_PULSE_SHORT, \
|
||
|
.initial_value = !APPLE_RESET_ACTIVE_VALUE }, \
|
||
|
{ \
|
||
|
.virtual_device = APPLE_VIRTUAL_CLR_SCR, .physical_device = APPLE_CLR_SCR_OUTPUT, \
|
||
|
.function = V_PULSE_LONG, .initial_value = !APPLE_CLR_SCR_ACTIVE_VALUE \
|
||
|
} \
|
||
|
}
|
||
|
|
||
|
|
||
|
#define ASDF_APPLE2_KEYMAP_INITIALIZER \
|
||
|
ASDF_APPLE2_PLAIN_KEYMAP_INITIALIZER, ASDF_APPLE2_CAPS_KEYMAP_INITIALIZER
|
||
|
|
||
|
// Structure to initialize hooks. No hook functions are needed for APPLE2 keyboard.
|
||
|
#define ASDF_APPLE2_KEYMAP_HOOK_INITIALIZER_LENGTH 0
|
||
|
#define ASDF_APPLE2_PLAIN_KEYMAP_HOOK_INITIALIZER \
|
||
|
{ \
|
||
|
}
|
||
|
#define ASDF_APPLE2_CAPS_KEYMAP_HOOK_INITIALIZER \
|
||
|
{ \
|
||
|
}
|
||
|
#define ASDF_APPLE2_KEYMAP_HOOK_INITIALIZER \
|
||
|
ASDF_APPLE2_PLAIN_KEYMAP_HOOK_INITIALIZER, ASDF_APPLE2_CAPS_KEYMAP_HOOK_INITIALIZER
|
||
|
|
||
|
|
||
|
// Key Matrix for combination of ASCII controller and Classic ASCII matrix
|
||
|
//
|
||
|
// Col-> 0 1 2 3 4 5 6 7
|
||
|
// Row 0 POWER R-Shift L-Shift (no key) ESC TAB CTRL \(backslash)
|
||
|
// Row 1 Rubout P ; / SPACEBAR Z A Q
|
||
|
// Row 2 Break ,(comma) M N B V C X
|
||
|
// Row 3 Spare K J H G F D A
|
||
|
// Row 4 Rt arrow I U Y T R E W
|
||
|
// Row 5 LT arrow Repeat CapsLock Return LineFeed O(alpha) L .(period)
|
||
|
// Row 6 ~(tilde) ] [ -(dash) :(colon) 0(numeral) 9 8
|
||
|
// Row 7 @(at) 7 6 5 4 3 2 1
|
||
|
//
|
||
|
// Row 15 DIP switches 0-7
|
||
|
//
|
||
|
// Notes:
|
||
|
//
|
||
|
// 1) The keys above correspond to the silk screen on the PCB. For the OSI and
|
||
|
// Apple layouts, the keys may not all match the silk screen. When creating a
|
||
|
// layout different from the silk screen, look up the row and column for the
|
||
|
// silk screen label at the desired position, and then place the desired
|
||
|
// function in the keymap definition at the desired row and column. For
|
||
|
// example, the Apple 2 keymap places the "RESET" key at the "[" silk-screen
|
||
|
// position, Row 6, Col 2. The keymap places ACTION_RESET at Row 6, Col 2 in
|
||
|
// the "ASDF_APPLE2_CTRL_MAP" to map the RESET function to the CTRL-RESET key
|
||
|
// combination.
|
||
|
//
|
||
|
// 2) To ensure consistent DIP switch operation within the keymap, a
|
||
|
// ASDF_ASCII_DIP_SWITCHES macro is defined. Keeping the ACTION_MAPSEL0-3
|
||
|
// definitions in positions 0-3 ensures consistent map selection among all
|
||
|
// keymaps.
|
||
|
|
||
|
#define ASDF_APPLE2_DIP_SWITCHES ASDF_KEYMAP_DIP_SWITCHES
|
||
|
|
||
|
#define APPLE_LEFT_ARROW ASCII_CTRL_H
|
||
|
#define APPLE_RIGHT_ARROW ASCII_CTRL_U
|
||
|
|
||
|
// clang-format off
|
||
|
#define ASDF_APPLE2_PLAIN_MAP \
|
||
|
{ \
|
||
|
[0] = { ACTION_CAPS, ACTION_SHIFT, ACTION_SHIFT, ACTION_NOTHING, \
|
||
|
ACTION_NOTHING, ASCII_ESC, ACTION_CTRL, APPLE_RIGHT_ARROW }, \
|
||
|
[1] = { ASCII_DEL, 'p', ';', '/', ASCII_SPACE, 'z', 'a', 'q' }, \
|
||
|
[2] = { ACTION_NOTHING, ASCII_COMMA, 'm', 'n', 'b', 'v', 'c', 'x' }, \
|
||
|
[3] = { ACTION_NOTHING, 'k', 'j', 'h', 'g', 'f', 'd', 's' }, \
|
||
|
[4] = { ACTION_NOTHING, 'i', 'u', 'y', 't', 'r', 'e', 'w' }, \
|
||
|
[5] = { ACTION_NOTHING, ACTION_NOTHING, ACTION_NOTHING, ASCII_CR, '^', 'o', 'l', ASCII_PERIOD }, \
|
||
|
[6] = { ACTION_NOTHING, ACTION_NOTHING, ACTION_NOTHING, '-', ':', ASCII_ZERO, '9', '8' }, \
|
||
|
[7] = { APPLE_LEFT_ARROW, '7', '6', '5', '4', '3', '2', '1' }, \
|
||
|
ASDF_APPLE2_DIP_SWITCHES \
|
||
|
}
|
||
|
|
||
|
#define ASDF_APPLE2_SHIFT_MAP \
|
||
|
{ \
|
||
|
[0] = { ACTION_CAPS, ACTION_SHIFT, ACTION_SHIFT, ACTION_NOTHING, \
|
||
|
ACTION_NOTHING, ASCII_ESC, ACTION_CTRL, APPLE_RIGHT_ARROW }, \
|
||
|
[1] = { ACTION_NOTHING, 'P', '+', '?', ASCII_SPACE, 'Z', 'A', 'Q' }, \
|
||
|
[2] = { ACTION_NOTHING, '<', 'M', 'N', 'B', 'V', 'C', 'X' }, \
|
||
|
[3] = { ACTION_NOTHING, 'K', 'J', 'H', 'G', 'F', 'D', 'S' }, \
|
||
|
[4] = { ACTION_NOTHING, 'I', 'U', 'Y', 'T', 'R', 'E', 'W' }, \
|
||
|
[5] = { ACTION_NOTHING, ACTION_NOTHING, ACTION_NOTHING, ASCII_CR, ASCII_AT, 'O', 'L', '>' }, \
|
||
|
[6] = { ACTION_NOTHING, ACTION_NOTHING, APPLE_ACTION_CLEAR, '=', \
|
||
|
'*', ASCII_ZERO, ASCII_RT_PAREN, ASCII_LT_PAREN }, \
|
||
|
[7] = { APPLE_LEFT_ARROW, ASCII_SINGLE_QUOTE, '&', '%', '$', '#', ASCII_DOUBLE_QUOTE, '!' }, \
|
||
|
ASDF_APPLE2_DIP_SWITCHES \
|
||
|
}
|
||
|
|
||
|
#define ASDF_APPLE2_CAPS_MAP \
|
||
|
{ \
|
||
|
[0] = { ACTION_CAPS, ACTION_SHIFT, ACTION_SHIFT, ACTION_NOTHING, \
|
||
|
ACTION_NOTHING, ASCII_ESC, ACTION_CTRL, APPLE_RIGHT_ARROW }, \
|
||
|
[1] = { ACTION_NOTHING, 'P', ';', '/', ASCII_SPACE, 'Z', 'A', 'Q' }, \
|
||
|
[2] = { ACTION_NOTHING, ASCII_COMMA, 'M', 'N', 'B', 'V', 'C', 'X' }, \
|
||
|
[3] = { ACTION_NOTHING, 'K', 'J', 'H', 'G', 'F', 'D', 'S' }, \
|
||
|
[4] = { ACTION_NOTHING, 'I', 'U', 'Y', 'T', 'R', 'E', 'W' }, \
|
||
|
[5] = { ACTION_NOTHING, ACTION_NOTHING, ACTION_NOTHING, ASCII_CR, ACTION_REPEAT, 'O', 'L', ASCII_PERIOD }, \
|
||
|
[6] = { ACTION_NOTHING, ACTION_NOTHING, ACTION_NOTHING, '-', ':', ASCII_ZERO, '9', '8' }, \
|
||
|
[7] = { APPLE_LEFT_ARROW, '7', '6', '5', '4', '3', '2', '1' }, \
|
||
|
ASDF_APPLE2_DIP_SWITCHES \
|
||
|
}
|
||
|
|
||
|
|
||
|
#define ASDF_APPLE2_SHIFT_CAPS_MAP \
|
||
|
{ \
|
||
|
[0] = { ACTION_CAPS, ACTION_SHIFT, ACTION_SHIFT, ACTION_NOTHING, \
|
||
|
ACTION_NOTHING, ASCII_ESC, ACTION_CTRL, APPLE_RIGHT_ARROW }, \
|
||
|
[1] = { ACTION_NOTHING, ASCII_AT, '+', '?', ASCII_SPACE, 'Z', 'A', 'Q' }, \
|
||
|
[2] = { ACTION_NOTHING, '<', 'M', '^', 'B', 'V', 'C', 'X' }, \
|
||
|
[3] = { ACTION_NOTHING, 'K', 'J', 'H', 'G', 'F', 'D', 'S' }, \
|
||
|
[4] = { ACTION_NOTHING, 'I', 'U', 'Y', 'T', 'R', 'E', 'W' }, \
|
||
|
[5] = { ACTION_NOTHING, ACTION_NOTHING, ACTION_NOTHING, ASCII_CR, ACTION_REPEAT, 'O', 'L', '>' }, \
|
||
|
[6] = { ACTION_NOTHING, ACTION_NOTHING, APPLE_ACTION_CLEAR, '=', \
|
||
|
'*', ASCII_ZERO, ASCII_RT_PAREN, ASCII_LT_PAREN }, \
|
||
|
[7] = { APPLE_LEFT_ARROW, ASCII_SINGLE_QUOTE, '&', '%', '$', '#', ASCII_DOUBLE_QUOTE, '!' }, \
|
||
|
ASDF_APPLE2_DIP_SWITCHES \
|
||
|
}
|
||
|
|
||
|
#define ASDF_APPLE2_CTRL_MAP \
|
||
|
{ \
|
||
|
[0] = { ACTION_CAPS, ACTION_SHIFT, ACTION_SHIFT, ACTION_NOTHING, \
|
||
|
ACTION_NOTHING, ASCII_ESC, ACTION_CTRL, APPLE_RIGHT_ARROW }, \
|
||
|
[1] = { ACTION_NOTHING, ASCII_CTRL_P, ACTION_NOTHING, ACTION_NOTHING, \
|
||
|
ASCII_SPACE, ASCII_CTRL_Z, ASCII_CTRL_A, ASCII_CTRL_Q }, \
|
||
|
[2] = { ACTION_NOTHING, ASCII_COMMA, ASCII_CTRL_M, ASCII_CTRL_N, \
|
||
|
ASCII_CTRL_B, ASCII_CTRL_V, ASCII_CTRL_C, ASCII_CTRL_X }, \
|
||
|
[3] = { ACTION_NOTHING, ASCII_CTRL_K, ASCII_CTRL_J, ASCII_CTRL_H, \
|
||
|
ASCII_CTRL_G, ASCII_CTRL_F, ASCII_CTRL_D, ASCII_CTRL_S }, \
|
||
|
[4] = { ACTION_NOTHING, ASCII_CTRL_I, ASCII_CTRL_U, ASCII_CTRL_Y, \
|
||
|
ASCII_CTRL_T, ASCII_CTRL_R, ASCII_CTRL_E, ASCII_CTRL_W }, \
|
||
|
[5] = { ACTION_NOTHING, ACTION_NOTHING, ACTION_NOTHING, ASCII_CR, \
|
||
|
ACTION_REPEAT, ASCII_CTRL_O, ASCII_CTRL_L, ACTION_NOTHING }, \
|
||
|
[6] = { ACTION_NOTHING, ACTION_NOTHING, APPLE_ACTION_RESET, ACTION_NOTHING, \
|
||
|
ACTION_NOTHING, ACTION_FN_10, ACTION_FN_9, ACTION_FN_8 }, \
|
||
|
[7] = { APPLE_LEFT_ARROW, ACTION_FN_7, ACTION_FN_6, ACTION_FN_5, \
|
||
|
ACTION_FN_4, ACTION_FN_3, ACTION_FN_2, ACTION_FN_1 }, \
|
||
|
ASDF_APPLE2_DIP_SWITCHES \
|
||
|
}
|
||
|
// clang-format on
|
||
|
|
||
|
#define ASDF_APPLE2_MAP_DECLARATIONS \
|
||
|
static const FLASH keycode_matrix_t apple2_plain_matrix = ASDF_APPLE2_PLAIN_MAP; \
|
||
|
static const FLASH keycode_matrix_t apple2_shift_matrix = ASDF_APPLE2_SHIFT_MAP; \
|
||
|
static const FLASH keycode_matrix_t apple2_caps_matrix = ASDF_APPLE2_CAPS_MAP; \
|
||
|
static const FLASH keycode_matrix_t apple2_caps_shift_matrix = ASDF_APPLE2_SHIFT_CAPS_MAP; \
|
||
|
static const FLASH keycode_matrix_t apple2_ctrl_matrix = ASDF_APPLE2_CTRL_MAP;
|
||
|
|
||
|
|
||
|
// Here, you can specify which maps are associated with which modifier keys.
|
||
|
// There can be multiple definitions. For example, as shown here, an ALL CAPS
|
||
|
// keymap can be made by assigning the caps map to the "no modifier" position.
|
||
|
// Or, more additional keymaps can be defined above, and keymap sets can be
|
||
|
// defined below that pick and choose between them. The modifiers are assigned as follows:
|
||
|
//
|
||
|
// [0]: plain (no modifiers)
|
||
|
// [1]: shift (shift key or shift lock active)
|
||
|
// [2]: caps (caps lock active)
|
||
|
// [3]: ctrl: (control key active)
|
||
|
|
||
|
#define ASDF_APPLE2_PLAIN_MAP_DEFS \
|
||
|
{ \
|
||
|
[MOD_PLAIN_MAP] = &apple2_plain_matrix, [MOD_SHIFT_MAP] = &apple2_shift_matrix, \
|
||
|
[MOD_CAPS_MAP] = &apple2_caps_matrix, [MOD_CTRL_MAP] = &apple2_ctrl_matrix \
|
||
|
}
|
||
|
|
||
|
#define ASDF_APPLE2_CAPS_MAP_DEFS \
|
||
|
{ \
|
||
|
[MOD_PLAIN_MAP] = &apple2_caps_matrix, [MOD_SHIFT_MAP] = &apple2_caps_shift_matrix, \
|
||
|
[MOD_CAPS_MAP] = &apple2_caps_matrix, [MOD_CTRL_MAP] = &apple2_ctrl_matrix \
|
||
|
}
|
||
|
|
||
|
#define ASDF_APPLE2_ALL_MAPS ASDF_APPLE2_PLAIN_MAP_DEFS, ASDF_APPLE2_CAPS_MAP_DEFS
|
||
|
|
||
|
#define ASDF_APPLE2_ALL_MAPS_COUNT 2
|
||
|
|
||
|
#if !defined(ASDF_NUM_ROWS) || (ASDF_NUM_ROWS < ASDF_APPLE2_NUM_ROWS)
|
||
|
#undef ASDF_NUM_ROWS
|
||
|
#define ASDF_NUM_ROWS ASDF_APPLE2_NUM_ROWS
|
||
|
#endif
|
||
|
|
||
|
#if !defined(ASDF_NUM_COLS) || (ASDF_NUM_COLS < ASDF_APPLE2_NUM_COLS)
|
||
|
#undef ASDF_NUM_COLS
|
||
|
#define ASDF_NUM_COLS ASDF_APPLE2_NUM_COLS
|
||
|
#endif
|
||
|
|
||
|
#if !defined(ASDF_KEYMAP_INITIALIZER_LENGTH) \
|
||
|
|| (ASDF_KEYMAP_INITIALIZER_LENGTH < ASDF_APPLE2_KEYMAP_INITIALIZER_LENGTH)
|
||
|
#undef ASDF_KEYMAP_INITIALIZER_LENGTH
|
||
|
#define ASDF_KEYMAP_INITIALIZER_LENGTH ASDF_APPLE2_KEYMAP_INITIALIZER_LENGTH
|
||
|
#endif
|
||
|
|
||
|
#if !defined(ASDF_KEYMAP_HOOK_INITIALIZER_LENGTH) \
|
||
|
|| (ASDF_KEYMAP_HOOK_INITIALIZER_LENGTH < ASDF_APPLE2_KEYMAP_HOOK_INITIALIZER_LENGTH)
|
||
|
#undef ASDF_KEYMAP_HOOK_INITIALIZER_LENGTH
|
||
|
#define ASDF_KEYMAP_HOOK_INITIALIZER_LENGTH ASDF_APPLE2_KEYMAP_HOOK_INITIALIZER_LENGTH
|
||
|
#endif
|
||
|
|
||
|
#endif /* !defined (ASDF_KEYMAP_DEFS_APPLE2_H) */
|
||
|
|
||
|
//-------|---------|---------+---------+---------+---------+---------+---------+
|
||
|
// Above line is 80 columns, and should display completely in the editor.
|