ZX_BUS_Mouse — контроллер PS/2 Kempston Mouse для шины ZX-BUS

ZX_BUS_Mouse — это максимально компактный, простой в повторении открытый интерфейс PS/2 Kempston Mouse для шины ZX-BUS (совместим также с Nemo-BUS). Проект включает прошивки микроконтроллера и CPLD, схему и разводку платы в KiCad.

Файлы для загрузки​

История версий​

Входные требования​

• Разработать максимально компактный простой в повторении интерфейс PS/2 Kempston Mouse для шины ZX-BUS
• Исходники прошивок микроконтроллера/CPLD, схема и разводка платы — полностью открыты
• Сигнал WAIT микропроцессора не должен использоваться

Не входит в требования:

• Поддержка USB мыши (объём аппаратной и программной поддержки USB стека не соответствует сложности задачи)

Описание интерфейса Kempston Mouse​

Контроллер доступен как три 8-разрядных регистра кнопок и осей X/Y по адресам:

Регистр MKEY:

• Биты 0–2 — инвертированные значения левой, правой, средней кнопок мыши
• Бит 3 — зарезервирован под четвёртую кнопку (всегда =1)
• Биты 4–7 — значение оси mouse wheel (если поддержана; начальное %0000). Если wheel не поддержана — всегда %1111

При переполнении 8-битных значений координат осей происходит перенос. Значения осей — 8-битное целое со знаком в дополнительном коде.

Спецификация оси mouse wheel публично зафиксирована в сообщении в Fido эхоконференции REAL SPECCY.
Дополнительная информация: https://speccy.info/Kempston_Mouse

Нажмите, чтобы развернуть...

Некоторые исторические реализации и публикации​

Детали реализации​

Для реализации выбрана связка ATmega8 + EPM3032. Общая идея, схема включения и выбор битов адреса для дешифрации портов взяты из Deltagon 1.5 (Евгений Королёв @djking26, Игорь Матвеев @azx987sa).

ATmega8:

• Прошивка написана на C. В отдельной ветке есть упрощённая версия на библиотеках Arduino.
• Аппаратные прерывания по фронтам PS/2 MDATA/MCLK и таймеры не использовались для большей понятности кода. Однако сигналы MDATA/MCLK подключены к INT1/INT0 — есть альтернативная прошивка, использующая аппаратное прерывание от PS/2 clock (для разработчиков).

CPLD EPM3032:

• Реализация регистров интерфейса, дешифрации адресов и формирования сигнала IORQGE выполнена на Verilog (есть также менее понятная реализация на VHDL).
• Используется 31 из 32 макроячеек с отключёнными битами оси mouse wheel; 33 макроячейки при включении битов wheel.
• По умолчанию: поддержка двух кнопок и mouse wheel — используется 32 макроячейки.
• Теоретически возможно использование EPM3064 или оптимизация кода.
• Формирование сигнала IORQGE/ происходит исходя из битов адресов A0, A1, A7, A5 и сигнала M1/.

Инициализация:

• При подаче питания до первого пакета от PS/2 мыши в регистры MKEY, MX, MY записываются значения 0xFF, 0x80, 0x60.
• При отключённой поддержке wheel в старших 4 битах MKEY — %1111; при включённой — начальное значение оси %0000.

Отладка:

• Проводилась на Pentagon 2024 и сверялась с эмулятором Unreal Speccy 0.39.0 (референс).
• Подтверждена работа на Scorpion ZS 256, Scorpion ZS 1024, Pentagon 1024ZP Crocodile Edition.

Известные проблемы​

• На Scorpion ZS 256 в меню сервисного монитора мышь работает некорректно (при этом тест в RAM работает). Не работает загрузка с ROM диска в ПрофПЗУ при включённой опции графических манипуляторов. Исправлено добавлением сигнала A15 в схему дешифрации (также проблема исправляется использованием сигнала /DOS).
• Некорректная работа регистров осей в CPLD (перепутанные биты) — решается перекомпиляцией и перепрошивкой CPLD.
• На некоторых платах с неправильной реализацией IORQGE возможен конфликт с портом Kempston Joystick.

Сомнительные моменты (решённые)​

• PS/2 мышь может требовать задержку перед инициализацией. Решено перезагрузкой контроллера через 2 секунды ожидания инициализации.
• Проблема с Gluk Reset Service: Мышь при включении автоматически не определяется (ATmega не успевает проинициализировать PS/2 мышь за 1–2 с и выставить регистры за ~6 мкс). Варианты решения: (1) удерживать /RESET Z80 контроллером (как в ZXMC); (2) инициализировать регистры сразу после включения. В коде реализован второй вариант.

Bill of Materials (BOM)​

Отладочные компоненты:

• R8, R9 — 2.2 кОм (1206) — подтяжка I2C SDA/SCL
• J6 — разъём 1×04 (PinHeader 2.54mm) — I2C для OLED

Сборка прошивок​

ATmega8:

• Требуется: WinAVR-20100110, MSYS2
• Команды: make clean, make all
• Fuses: Low=0xC4, High=0xD9

Altera EPM3032:

• Требуется: Quartus II Web Edition 9.1 SP2 или 13.0 SP1
• Открыть проект → Start Compilation → Programmer (USB Blaster) → выбрать .pof → Program/Configure/Verify → Start

Прошивка​

ATmega8:

• Программатор CH341A, ПО NeoProgrammer V2.2. Прижать ISP-гребёнку под углом (можно не припаивать).

Altera EPM3032:

• Altera USB Blaster (или китайский аналог на CH552G — может потребоваться обновление прошивки программатора). Драйвер — из quartus/drivers/usb-blaster.
• Важно: при прошивке CPLD подайте внешнее питание 5V (через ISP или слот ZX-BUS). На практике плата успешно перешивалась на включённом Pentagon 2024.
• Б/у чипы EPM3032 могут быть залочены — можно попытаться разблокировать или заказать у другого поставщика.

Поддержка mouse wheel​

Отладка​

С OLED дисплеем I2C 128×32:

• Запаять R8, R9 (2.2 кОм), подключить дисплей к разъёму I2C.
• Прошить отладочную прошивку ZX_BUS_Mouse_ATmega8_Fuses_C4_D9_Debug_OLED_128x32.hex
• При движении мыши будут выводиться координаты и состояние wheel/кнопок.

Со светодиодом:

• Подключить светодиод (короткий пин — к GND) к контактам SDA и GND разъёма I2C.
• Прошить ZX_BUS_Mouse_ATmega8_Fuses_C4_D9_Debug_LED_SDA_GND.hex
• При успешной инициализации PS/2 светодиод загорается; при нажатии кнопок гаснет.

Тестовое ПО​

MousTest (C) 2012 Patrik Rak (raxoft) — в папке test.

Credits (Благодарности)​

• Общая идея, схема включения, выбор битов адреса: Deltagon 1.5 (Евгений Королёв @djking26, Игорь Матвеев @azx987sa)
• @Alex_Eburg — ZX BUS PCB Prototype Board
• Black_Cat — BC Info Guide #7 «Стандартизация ZXBus интерфейсов и шин» (c) 2011–2020
• Adam Chapweske — PS/2 Mouse/Keyboard Protocol (1999), The PS/2 Mouse Interface (2003)
• Kris Chambers — Arduino/Wiring Library for PS2 mouse
• Patrik Rak (raxoft) — MousTest
• Sylaina — OLED for AVR mikrocontrollers library
• Velesoft — RUSKA VERZE KEMPSTON MOUSE (скриншоты статей)
• Zxdn — Электроника/схемы устройств (Клавиатуры, мыши)
• Калинин Вячеслав/newart — zxpress.ru
• @AMM — поддержка в начальном запуске
• @Michael_Kaa — помощь в тестировании на Scorpion ZS 256
• Denis (Новый Уренгой) — тестирование и отладка на Scorpion ZS 256
• @djking26 — локализация проблемы с Gluk Reset Service

Полезные ссылки проекта:​

• Спецификация Kempston Mouse (speccy.info) — https://speccy.info/Kempston_Mouse
• Документация на контроллер Scorpion & Д.К. (V2.1) — часть 1 | часть 2
• Прошивка USB-Blaster на CH552G — подробнее
• WCH ISP Studio — https://www.wch.cn/downloads/WCHISPTool_Setup_exe.html
• NeoProgrammer V2.2 — для прошивки ATmega через CH341A
• WinAVR-20100110 — для сборки прошивки ATmega8
• Quartus II Web Edition 9.1 SP2 / 13.0 SP1 — для сборки прошивки CPLD
• Репозиторий проекта — GitHub