chore: Update changelog for 5.45 release

Also includes EXTIO. Run a SD style cabinet with bemanitools
ddrio API.

.github/ISSUE_TEMPLATE/bug.md

@@ -1,17 +1,24 @@
+# Bug report
+
 ## Summary
+
 <!--- Provide a general summary of the issue in the Title above -->
 
 ## Expected behavior
+
 <!--- Tell us what should happen -->
 
 ## Current behavior
+
 <!--- Tell us what happens instead of the expected behavior -->
 
 ## Detailed Description
+
 <!--- Provide a detailed description of the issue. Include links to screenshots or videos if
 necessary -->
 
 ## Steps to reproduce
+
 <!-- Try running the game with a default configuration as well. If that also causes issues, please point that out here in the report. This might speed up the debugging process.-->
 
 <!--- Provide a detailed step by step description how to reproduce this issue -->
@@ -21,17 +28,23 @@ necessary -->
 4.
 
 ## Possible solution
+
 <!--- Not obligatory, but suggest a fix/reason for the bug, -->
 
 ## Context (Environment)
+
 ### Bemanitools version(s) affected
+
 * <!--- Add one or multiple versions as a bullet list -->
 
 ### Game(s) and version(s) affected
+
 * <!--- Add one or multiple game versions as a bullet list -->
 
 ### Log output
+
 See attachment.
+
 <!---
 Provide FULL log output, e.g. inject.log or launcher.log. Please do not guess which things
 are relevant or not. Without knowing, you might leave out things that are relevant for the developers. You have to enable log output explicitly if not done already. 
@@ -50,7 +63,9 @@ Use the search and replace feature of any kind of text editor.
 -->
 
 ### Configuration files
+
 See attachment.
+
 <!--- Provide any configuration files that you used, e.g. iidxhook-XX.conf. This file is located in
 the same directory as launcher.exe or inject.exe. 
 
@@ -66,17 +81,21 @@ Use the search and replace feature of any kind of text editor.
 -->
 
 ### Command line arguments
+
 <!--- Provide how you run the game from the command line, e.g. which gamestart.bat you used and any
 additional arguments that you provided to it. Also provide the contents of the gamestart.bat you
 used if you altered it. -->
 
 ### APIs used
+
 * <!--- List all APIs you used as a bullet list, e.g. iidxio-keyboard, eamio-keyboard -->
 
 ### OS version
+
 <!--- Provide the version of Windows you used with whatever update/build identifier -->
 
 ### Hardware specs
+
 * CPU: <!--- Insert, e.g. Core i7 2600k 3.20ghz -->
 * RAM: <!--- Insert, e.g. 16 GB -->
 * GPU: <!--- Insert, e.g. Nvidia GeForce GTX 970, 4GB -->

.github/ISSUE_TEMPLATE/feature.md

@@ -1,14 +1,21 @@
+# Feature request
+
 ## Summary
+
 <!--- Provide a general summary of your changes in the Title above -->
 
 ## Detailed description
+
 <!--- Describe your feature in detail -->
 
 ## Benefits
+
 <!--- Describe the value/benefits of the feature in detail -->
 
 ## Drawbacks
+
 <!--- Describe any drawbacks that might be introduced with this feature -->
 
 ## Current blockers
+
 <!--- Describe any blockers that need to be resolved before implementing this feature -->

.github/PULL_REQUEST_TEMPLATE/pull-request.md

@@ -1,23 +1,31 @@
+# Pull request
+
 ## Summary
+
 <!--- Provide a general summary of your changes in the Title above -->
 
 ## Description
+
 <!--- Describe your changes in detail -->
 
 ## Related Issue
+
 <!--- This project only accepts pull requests related to open issues -->
 <!--- If suggesting a new feature or change, please discuss it in an issue first -->
 <!--- If fixing a bug, there should be an issue describing it with steps to reproduce -->
 <!--- Please link to the issue here: -->
 
 ## How Has This Been Tested?
+
 <!--- Please describe in detail how you tested your changes. -->
 <!--- Include details of your testing environment, and the tests you ran to -->
 <!--- see how your change affects other areas of the code, etc. -->
 
 ## Checklist
+
 <!-- Make sure you covered all items, which apply, of the checklist below. -->
 <!-- Strikethrough items that do not apply and provide a brief description why. -->
+
 * [ ] Implemented (unit) test(s) which prove that the introduced changes are working as expected.
 * Tested with the following games:
     * [ ] ... <!-- insert game name 1-->

.github/workflows/build-master.yaml

@@ -0,0 +1,39 @@
+name: "Build bemanitools"
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  build:
+    runs-on: "ubuntu-22.04"
+    steps:
+      - name: "Checkout repository"
+        uses: "actions/checkout@v2"
+
+      - name: "Install prerequisites"
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y runc containerd docker.io
+
+      - name: "Build"
+        run: |
+          make build-docker
+
+      # Do some unpacking of the dist zip. Artifact upload repackages stuff
+      - name: "Prepare artifact package"
+        run: |
+          mkdir artifact
+          cd artifact
+          unzip ../build/bemanitools.zip
+          cd ..
+
+      - name: "Upload artifact"
+        uses: "actions/upload-artifact@v2"
+        with:
+          name: bemanitools-${{ github.sha }}
+          retention-days: 90
+          if-no-files-found: "error"
+          path: |
+            artifact/**

.github/workflows/build-tag.yaml

@@ -0,0 +1,75 @@
+name: "Build bemanitools and publish release"
+
+permissions:
+  contents: write
+  packages: write
+
+on:
+  push:
+    tags:
+      - "*.*"
+
+jobs:
+  build:
+    runs-on: "ubuntu-22.04"
+    steps:
+      - name: "Checkout repository"
+        uses: "actions/checkout@v2"
+
+      # Building bootstrapped using docker containers
+      - name: "Install prerequisites"
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y runc containerd docker.io
+      
+      - name: "Build"
+        run: |
+          make build-docker
+
+      # Do some unpacking of the dist zip. Artifact upload repackages stuff
+      - name: "Prepare artifact package"
+        run: |
+          mkdir artifact
+          cd artifact
+          unzip ../build/bemanitools.zip
+          cd ..
+
+      - name: "Upload artifact"
+        uses: "actions/upload-artifact@v2"
+        with:
+          name: bemanitools-${{ github.sha }}
+          retention-days: 90
+          if-no-files-found: "error"
+          path: |
+            artifact/**
+
+  publish-release:
+    needs: "build"
+    runs-on: "ubuntu-22.04"
+    steps:
+      # This already extracts the contents of the artifact
+      - name: "Download artifact"
+        uses: "actions/download-artifact@v2"
+        with:
+          name: bemanitools-${{ github.sha }}
+
+      - name: "Get the version"
+        id: get_version
+        run: |
+          echo ::set-output name=VERSION::$(echo $GITHUB_REF | cut -d / -f 3)
+
+      # The publish release action does not package the artifact *sigh*
+      - name: "Create release package"
+        run: |
+          zip bemanitools-${{ steps.get_version.outputs.VERSION }}.zip *
+
+      - name: "Publish release"
+        uses: "marvinpinto/action-automatic-releases@v1.2.1"
+        with:
+          repo_token: "${{ secrets.GITHUB_TOKEN }}"
+          automatic_release_tag: "latest"
+          draft: false
+          prerelease: true
+          title: ${{ steps.get_version.outputs.VERSION }}
+          files: |
+            bemanitools-${{ steps.get_version.outputs.VERSION }}.zip

.gitignore

@@ -3,4 +3,5 @@ build/
 .idea
 .vscode
 .vs
-version
+version
+.DS_Store

.gitlab/merge_request_templates/Feature.md

@@ -1,27 +0,0 @@
-## Summary
-<!--- Provide a general summary of your changes in the Title above -->
-
-## Description
-<!--- Describe your changes in detail -->
-
-## Related Issue
-<!--- This project only accepts pull requests related to open issues -->
-<!--- If suggesting a new feature or change, please discuss it in an issue first -->
-<!--- If fixing a bug, there should be an issue describing it with steps to reproduce -->
-<!--- Please link to the issue here: -->
-
-## How Has This Been Tested?
-<!--- Please describe in detail how you tested your changes. -->
-<!--- Include details of your testing environment, and the tests you ran to -->
-<!--- see how your change affects other areas of the code, etc. -->
-
-## Checklist
-<!-- Make sure you covered all items, which apply, of the checklist below. -->
-<!-- Strikethrough items that do not apply and provide a brief description why. -->
-* [ ] Implemented (unit) test(s) which prove that the introduced changes are working as expected.
-* Tested with the following games:
-    * [ ] ... <!-- insert game name 1-->
-    * [ ] ... <!-- insert game name 2--->
-* [ ] Followed the developer (style) guidelines.
-* [ ] Updated existing doc of or add new doc to README file(s).
-* [ ] Updated development documentation.

CHANGELOG.md

@@ -2,6 +2,57 @@
 Note for CI/CD: Ensure the version formatting in the sections is kept identical to the versions
 given in tags. The pipeline will pick this up and cuts out the relevant section for release notes.
 
+## 5.45
+### Features
+* feat(iidx 30): Added support
+* feat(ddr): Add ddrio implementation with P3IO driver backend
+* feat(ddr): Add p3io-ddr-tool for testing/debugging real P3IO devices with EXTIO
+* feat(ddr): Add testing tool for real EXTIO devices
+* feat(ddr): Add extio driver
+* feat(ddr): Add p3io driver
+* feat(iidx 20-26): New/fixed gfx up-/downscaling feature, old one was broken
+* feat(ddr): Vigem driver for ddrio
+* feat(iidx 25-30): The user can now set a custom camera device override of "SKIP" to leave that camera unassigned
+
+### Fixes
+* fix(iidx 09/10): Fix stretched BGAs on 1st and 3rd style videos
+
+## 5.44
+### Features
+* feat(doc): ezusb dev journal entry, 10th style ezusb boot up and security setup
+* feat(iidx 09/10): ezusb API call monitoring module and configuration flag
+* feat(iidx 19): Add back btools monitor check for iidxhook5
+* feat(iidx 9-19): Add configurable settings path hook. Redirect settings paths, i.e. `d/`, `e/` and
+  `f/` drive "folders" to an arbitrary path on any partition, e.g. writable partition
+* feat(iidx 9/10): Improve commandline script for irbeat-patch 09 and 10, add interactive mode
+
+### Fixes
+* fix(iidx 10): SQ-INIT error caused by incorrect security configuration
+* fix(iidx 9-24): Wire up coin input in ezusb1/2 IO emulation layer
+* fix(pnm 15-18): Fix IO buffer inconsistency causing random input misfiring
+* fix(jb 1-8): Fix IO buffer inconsistency causing random input misfiring
+* fix(iidx 9-24): Fix IO buffer inconsistency causing random input misfiring
+* fix(iidx 19): imagefs override strategy with local file redir. Required to enable monitor-check
+  on all chart files
+* fix(iidx 9-19): Code synchronization issue causing deadlock resulting in game hang/stuck on boot
+* fix(iidx 9-19): Fix broken settings path handling with mixed / and \
+* fix(iidx 27): Align disabled cam connection config defaults with 28/29
+* fix(inject): Fix missing forwarding of exit code
+* fix(inject): Getting stuck when game exits cleanly due to locked up debugger thread.
+* fix(iidx 18/19 CN): gamestart.bat creating dev/nvram and dev/raw folders
+
+## 5.43
+* iidx29: (Officially) support IIDX CASTHOUR
+* Code structure maintenance
+* Various documentation improvements
+
+## 5.42
+* Bugfix: Fix diagonal texture tearing on IIDX 18 and 19 based games
+* Feature: Add support for IIDX Resort Anthem CN using iidxhook4-cn 
+* Feature/bugfix: Enable "nvidia fix" for iidxhook4, 5 and 5-cn. Should fix crashing on some/all
+  nvidia cards
+* Various minor fixes
+
 ## 5.41
 * Feature: Support pop'n music 15-18 using popnhook1
 * Feature: Support IIDX tricoro CN using iidxhook5-cn

Dockerfile

@@ -1,32 +1,21 @@
-FROM fedora:31
+FROM --platform=amd64 debian:11.6-slim@sha256:f7d141c1ec6af549958a7a2543365a7829c2cdc4476308ec2e182f8a7c59b519
 
 LABEL description="Build environment for bemanitools"
 
-RUN yum -y install \
+# mingw-w64-gcc has 32-bit and 64-bit toolchains
-    git \
+RUN apt-get update && apt-get install -y --no-install-recommends \
+    mingw-w64 \
+    mingw-w64-common \
     make \
     zip \
-    clang \
+    git \
-    mingw64-gcc.x86_64 \
+ && rm -rf /var/lib/apt/lists/*
-    mingw32-gcc.x86_64 \
-    wine.x86_64
 
 RUN mkdir /bemanitools
 WORKDIR /bemanitools
 
-# Order optimized for docker layer caching
+ENTRYPOINT [ \
-COPY run-tests-wine.sh run-tests-wine.sh
+    "/bin/sh", \
-COPY CHANGELOG.md CHANGELOG.md
+    "-c" , \
-COPY CONTRIBUTING.md CONTRIBUTING.md
+    "cd /bemanitools && \
-COPY LICENSE LICENSE
+    make" ]
-COPY GNUmakefile GNUmakefile
-COPY Module.mk Module.mk
-COPY README.md README.md
-COPY doc doc
-COPY dist dist
-COPY src src
-# .git folder required or building fails when version is generated
-COPY .git .git
-
-# Building
-RUN make

GNUmakefile

@@ -14,7 +14,7 @@ BUILDDIR        ?= build
 builddir_docker 	  := $(BUILDDIR)/docker
 
 docker_container_name := "bemanitools-build"
-docker_image_name     := "bemanitools:build"
+docker_image_name     := "bemanitools-build:latest"
 
 depdir                := $(BUILDDIR)/dep
 objdir                := $(BUILDDIR)/obj
@@ -37,6 +37,8 @@ ldflags		          := -Wl,--gc-sections -static-libgcc
 
 all: build
 
+FORCE:
+
 .PHONY: \
 build-docker \
 clean \
@@ -44,7 +46,8 @@ code-format \
 print-building \
 print-release \
 run-tests \
-version
+version \
+FORCE
 
 release: \
 print-release \
@@ -69,7 +72,7 @@ clean:
 
 code-format:
 	$(V)echo "Applying clang-format..."
-	$(V)find src/ -name '*.c' -o -name '*.h' | xargs clang-format -i -style=file
+	$(V)find src/main src/test -name '*.c' -o -name '*.h' | xargs clang-format -i -style=file
 
 run-tests:
 	$(V)echo "Running tests..."
@@ -81,13 +84,21 @@ version:
 
 build-docker:
 	$(V)docker rm -f $(docker_container_name) 2> /dev/null || true
-	$(V)docker build -t $(docker_image_name) -f Dockerfile .
+	$(V)docker \
-	$(V)docker create --name $(docker_container_name) $(docker_image_name)
+		build \
-	$(V)rm -rf $(builddir_docker)
+		-t $(docker_image_name) \
-	$(V)mkdir -p $(builddir_docker)
+		-f Dockerfile \
-	$(V)docker cp $(docker_container_name):/bemanitools/build $(builddir_docker)
+		.
-	$(V)mv $(builddir_docker)/build/* $(builddir_docker)
+	$(V)docker \
-	$(V)rm -r $(builddir_docker)/build
+		run \
+		--volume $(shell pwd):/bemanitools \
+		--name $(docker_container_name) \
+		$(docker_image_name)
+
+clean-docker:
+	$(V)docker rm -f $(docker_container_name) || true
+	$(V)docker image rm -f $(docker_image_name) || true
+	$(V)rm -rf $(BUILDDIR)
 
 #
 # Pull in module definitions
@@ -185,6 +196,8 @@ $$(depdir_$1_$2_$3):
 $$(objdir_$1_$2_$3):
 	$(V)mkdir -p $$@
 
+$$(volatile_$3:%.c=$$(objdir_$1_$2_$3)/%.o): FORCE
+
 $$(objdir_$1_$2_$3)/%.o: $$(srcdir_$3)/%.c \
 		| $$(depdir_$1_$2_$3) $$(objdir_$1_$2_$3)
 	$(V)echo ... $$@

Module.mk

@@ -57,6 +57,7 @@
 #                   beatmania IIDX 22 PENDUAL
 #					beatmania IIDX 23 copula
 #                   beatmania IIDX 24 SINOBUZ
+#       Patch 3:    DanceDanceRevoluion A20+ (64-bit)
 #     "Patch" 3:    Silent Scope Bone Eater (compatible with p7)
 #	  "Patch" 7:    Steel Chronicle VicTroopers (not a Bemani, w/e)
 #
@@ -98,18 +99,25 @@ include src/main/bstio/Module.mk
 include src/main/camhook/Module.mk
 include src/main/cconfig/Module.mk
 include src/main/config/Module.mk
+include src/main/d3d9-util/Module.mk
 include src/main/d3d9exhook/Module.mk
 include src/main/ddrhook-util/Module.mk
 include src/main/ddrhook1/Module.mk
 include src/main/ddrhook2/Module.mk
+include src/main/ddrio-p3io/Module.mk
 include src/main/ddrio-mm/Module.mk
 include src/main/ddrio-smx/Module.mk
+include src/main/ddriotest/Module.mk
 include src/main/ddrio/Module.mk
 include src/main/dinput/Module.mk
 include src/main/eamio-icca/Module.mk
 include src/main/eamio/Module.mk
 include src/main/eamiotest/Module.mk
+include src/main/extio/Module.mk
+include src/main/extiodrv/Module.mk
+include src/main/extiotest/Module.mk
 include src/main/ezusb-emu/Module.mk
+include src/main/ezusb-iidx-16seg-emu/Module.mk
 include src/main/ezusb-iidx-emu/Module.mk
 include src/main/ezusb-iidx-fpga-flash/Module.mk
 include src/main/ezusb-iidx-sram-flash/Module.mk
@@ -131,11 +139,13 @@ include src/main/iidx-bio2-exit-hook/Module.mk
 include src/main/iidx-ezusb-exit-hook/Module.mk
 include src/main/iidx-ezusb2-exit-hook/Module.mk
 include src/main/iidx-irbeat-patch/Module.mk
+include src/main/iidxhook-d3d9/Module.mk
 include src/main/iidxhook-util/Module.mk
 include src/main/iidxhook1/Module.mk
 include src/main/iidxhook2/Module.mk
 include src/main/iidxhook3/Module.mk
 include src/main/iidxhook4/Module.mk
+include src/main/iidxhook4-cn/Module.mk
 include src/main/iidxhook5/Module.mk
 include src/main/iidxhook5-cn/Module.mk
 include src/main/iidxhook6/Module.mk
@@ -161,7 +171,9 @@ include src/main/launcher/Module.mk
 include src/main/mempatch-hook/Module.mk
 include src/main/mm/Module.mk
 include src/main/p3io/Module.mk
+include src/main/p3iodrv/Module.mk
 include src/main/p3ioemu/Module.mk
+include src/main/p3io-ddr-tool/Module.mk
 include src/main/p4iodrv/Module.mk
 include src/main/p4ioemu/Module.mk
 include src/main/popnhook-util/Module.mk
@@ -180,6 +192,7 @@ include src/main/util/Module.mk
 include src/main/vefxio/Module.mk
 include src/main/vigem-iidxio/Module.mk
 include src/main/vigem-sdvxio/Module.mk
+include src/main/vigem-ddrio/Module.mk
 include src/main/vigemstub/Module.mk
 
 include src/test/cconfig/Module.mk
@@ -201,6 +214,7 @@ $(zipdir)/:
 
 $(zipdir)/tools.zip: \
 		build/bin/indep-32/aciotest.exe \
+		build/bin/indep-32/ddriotest.exe \
 		build/bin/indep-32/eamiotest.exe \
 		build/bin/indep-32/ezusb-iidx-fpga-flash.exe \
 		build/bin/indep-32/ezusb-iidx-sram-flash.exe \
@@ -222,6 +236,7 @@ $(zipdir)/tools.zip: \
 
 $(zipdir)/tools-x64.zip: \
 		build/bin/indep-64/aciotest.exe \
+		build/bin/indep-64/ddriotest.exe \
 		build/bin/indep-64/eamiotest.exe \
 		build/bin/indep-64/iidxiotest.exe \
 		build/bin/indep-64/iidx-bio2-exit-hook.dll \
@@ -312,6 +327,21 @@ $(zipdir)/iidx-18.zip: \
 	$(V)echo ... $@
 	$(V)zip -j $@ $^
 
+$(zipdir)/iidx-18-cn.zip: \
+		build/bin/avs2_1101-32/iidxhook4-cn.dll \
+		build/bin/indep-32/config.exe \
+		build/bin/indep-32/geninput.dll \
+		build/bin/indep-32/iidxio.dll \
+		build/bin/indep-32/vefxio.dll \
+		build/bin/indep-32/inject.exe \
+		dist/iidx/config.bat \
+		dist/iidx/gamestart-18-cn.bat \
+		dist/iidx/iidxhook-18-cn.conf \
+		dist/iidx/vefx.txt \
+		| $(zipdir)/
+	$(V)echo ... $@
+	$(V)zip -j $@ $^
+
 $(zipdir)/iidx-19.zip: \
 		build/bin/avs2_1304-32/iidxhook5.dll \
 		build/bin/avs2_1304-32/launcher.exe \
@@ -347,7 +377,6 @@ $(zipdir)/iidx-20.zip: \
 $(zipdir)/iidx-20-cn.zip: \
 		build/bin/avs2_1304-32/iidxhook5-cn.dll \
 		build/bin/indep-32/config.exe \
-		build/bin/indep-32/eamio.dll \
 		build/bin/indep-32/geninput.dll \
 		build/bin/indep-32/iidxio.dll \
 		build/bin/indep-32/vefxio.dll \
@@ -400,7 +429,7 @@ $(zipdir)/iidx-25-to-26.zip: \
 	$(V)echo ... $@
 	$(V)zip -j $@ $^
 
-$(zipdir)/iidx-27-to-28.zip: \
+$(zipdir)/iidx-27-to-30.zip: \
 		build/bin/avs2_1700-64/iidxhook9.dll \
 		build/bin/avs2_1700-64/launcher.exe \
 		build/bin/indep-64/config.exe \
@@ -411,8 +440,12 @@ $(zipdir)/iidx-27-to-28.zip: \
 		dist/iidx/config.bat \
 		dist/iidx/gamestart-27.bat \
 		dist/iidx/gamestart-28.bat \
+		dist/iidx/gamestart-29.bat \
+		dist/iidx/gamestart-30.bat \
 		dist/iidx/iidxhook-27.conf \
 		dist/iidx/iidxhook-28.conf \
+		dist/iidx/iidxhook-29.conf \
+		dist/iidx/iidxhook-30.conf \
 		dist/iidx/vefx.txt \
 		| $(zipdir)/
 	$(V)echo ... $@
@@ -672,8 +705,6 @@ $(zipdir)/ddr-14-to-16.zip: \
 		build/bin/avs2_1508-32/unicorntail.dll \
 		build/bin/indep-32/config.exe \
 		build/bin/indep-32/ddrio.dll \
-		build/bin/indep-32/ddrio-mm.dll \
-		build/bin/indep-32/ddrio-smx.dll \
 		build/bin/indep-32/eamio.dll \
 		build/bin/indep-32/geninput.dll \
 		dist/ddr/config.bat \
@@ -690,8 +721,6 @@ $(zipdir)/ddr-16-x64.zip: \
 		build/bin/avs2_1603-64/unicorntail.dll \
 		build/bin/indep-64/config.exe \
 		build/bin/indep-64/ddrio.dll \
-		build/bin/indep-64/ddrio-mm.dll \
-		build/bin/indep-64/ddrio-smx.dll \
 		build/bin/indep-64/eamio.dll \
 		build/bin/indep-64/geninput.dll \
 		dist/ddr/config.bat \
@@ -700,6 +729,28 @@ $(zipdir)/ddr-16-x64.zip: \
 	$(V)echo ... $@
 	$(V)zip -j $@ $^
 
+$(zipdir)/ddr-hwio-x86.zip: \
+		build/bin/indep-32/ddrio-p3io.dll \
+		build/bin/indep-32/ddrio-mm.dll \
+		build/bin/indep-32/ddrio-smx.dll \
+		build/bin/indep-32/extiotest.exe \
+		build/bin/indep-32/p3io-ddr-tool.exe \
+		build/bin/indep-32/vigem-ddrio.exe \
+		| $(zipdir)/
+	$(V)echo ... $@
+	$(V)zip -j $@ $^
+
+$(zipdir)/ddr-hwio-x64.zip: \
+		build/bin/indep-64/ddrio-p3io.dll \
+		build/bin/indep-64/ddrio-mm.dll \
+		build/bin/indep-64/ddrio-smx.dll \
+		build/bin/indep-64/extiotest.exe \
+		build/bin/indep-64/p3io-ddr-tool.exe \
+		build/bin/indep-64/vigem-ddrio.exe \
+		| $(zipdir)/
+	$(V)echo ... $@
+	$(V)zip -j $@ $^
+
 $(zipdir)/bst.zip: \
 		build/bin/avs2_1603-64/bsthook.dll \
 		build/bin/avs2_1603-64/launcher.exe \
@@ -722,6 +773,7 @@ $(zipdir)/popn-15-to-18.zip: \
 		build/bin/indep-32/eamio.dll \
 		build/bin/indep-32/popnio.dll \
 		build/bin/indep-32/ezusb2-popn-shim.dll \
+		dist/popn/config.bat \
 		dist/popn/gamestart-15.bat \
 		dist/popn/gamestart-16.bat \
 		dist/popn/gamestart-17.bat \
@@ -774,17 +826,20 @@ $(BUILDDIR)/bemanitools.zip: \
 		$(zipdir)/ddr-13.zip \
 		$(zipdir)/ddr-14-to-16.zip \
 		$(zipdir)/ddr-16-x64.zip \
+		$(zipdir)/ddr-hwio-x86.zip \
+		$(zipdir)/ddr-hwio-x64.zip \
 		$(zipdir)/doc.zip \
 		$(zipdir)/iidx-09-to-12.zip \
 		$(zipdir)/iidx-13.zip \
 		$(zipdir)/iidx-14-to-17.zip \
 		$(zipdir)/iidx-18.zip \
+		$(zipdir)/iidx-18-cn.zip \
 		$(zipdir)/iidx-19.zip \
 		$(zipdir)/iidx-20.zip \
 		$(zipdir)/iidx-20-cn.zip \
 		$(zipdir)/iidx-21-to-24.zip \
 		$(zipdir)/iidx-25-to-26.zip \
-		$(zipdir)/iidx-27-to-28.zip \
+		$(zipdir)/iidx-27-to-30.zip \
 		$(zipdir)/iidx-hwio-x86.zip \
 		$(zipdir)/iidx-hwio-x64.zip \
 		$(zipdir)/jb-01.zip \

README.md

@@ -1,11 +1,11 @@
 # Bemanitools 5
 [![pipeline status](https://dev.s-ul.net/djhackers/bemanitools/badges/master/pipeline.svg)](https://dev.s-ul.net/djhackers/bemanitools/commits/master)
 
-Version: 5.41
+Version: 5.45
 
 [Release history](CHANGELOG.md)
 
-A collection of tools to run [various Bemani arcade games](#list-of-supported-games).
+A collection of tools to run [various Bemani arcade games](#supported-games).
 
 Bemanitools 5 (BT5) is the successor to Bemanitools 4 which introduces a big code cleanup and support for newer games.
 BT5 uses a cleaner approach than BT4 did; specifically, all input and lighting is handled by emulating the protocols
@@ -59,8 +59,10 @@ The following games are supported with their corresponding hook-libraries.
     * Beatmania IIDX 24 SINOBUZ (`iidx-21-to-24.zip`): [iidxhook7](doc/iidxhook/iidxhook7.md)
     * Beatmania IIDX 25 CANNON BALLERS (`iidx-25-to-26.zip`): [iidxhook8](doc/iidxhook/iidxhook8.md)
     * Beatmania IIDX 26 Rootage (`iidx-25-to-26.zip`): [iidxhook8](doc/iidxhook/iidxhook8.md)
-    * Beatmania IIDX 27 Heroic Verse (`iidx-27-to-28.zip`): [iidxhook9](doc/iidxhook/iidxhook9.md)
+    * Beatmania IIDX 27 Heroic Verse (`iidx-27-to-30.zip`): [iidxhook9](doc/iidxhook/iidxhook9.md)
-    * Beatmania IIDX 28 BISTROVER (`iidx-27-to-28.zip`): [iidxhook9](doc/iidxhook/iidxhook9.md)
+    * Beatmania IIDX 28 BISTROVER (`iidx-27-to-30.zip`): [iidxhook9](doc/iidxhook/iidxhook9.md)
+    * Beatmania IIDX 29 CASTHOUR (`iidx-27-to-30.zip`): [iidxhook9](doc/iidxhook/iidxhook9.md)
+    * Beatmania IIDX 30 RESIDENT (`iidx-27-to-30.zip`): [iidxhook9](doc/iidxhook/iidxhook9.md)
 * [jubeat](doc/jbhook/README.md)
     * jubeat (`jb-01.zip`): [jbhook1](doc/jbhook/jbhook1.md)
     * jubeat ripples (`jb-02.zip`): [jbhook1](doc/jbhook/jbhook1.md)
@@ -84,19 +86,46 @@ The following games are supported with their corresponding hook-libraries.
     * SOUND VOLTEX Vivid Wave (`sdvx-05-to-06`): sdvxhook2
     * SOUND VOLTEX EXCEED GEAR (`sdvx-05-to-06`): sdvxhook2
 
-## ViGEm clients: Expose BT5 APIs as XBOX game controllers
+## Auxiliary tooling
-Play your favorite non-bemani arcade games with any hardware, e.g. real cabinet hardware, that
+* Bootstrapping
-implements BT5 APIs.
+  * [inject](doc/inject.md): Inject arbitrary hooking libraries into a target application process.
+  * [launcher](doc/launcher.md): Bootstrap Konami's AVS environment and launch a target application with arbitrary
+    injected hooking libraries. 
+* Beatmnia IIDX Ezusb IO board
+  * [ezusb-iidx-fpga-flash](doc/tools/ezusb-iidx-fpga-flash.md): Flash a binary blob with FPGA firmware to a target
+    ezusb FX IO board
+  * [ezusb-iidx-sram-flash](doc/tools/ezusb-iidx-sram-flash.md): Flash a binary blob with SRAM contents to a target
+    ezusb FX2 IO board
+* Exit hooks: Exit the game with a button combination using native cabinet inputs
+  * [iidx-ezusb-exit-hook](doc/tools/iidx-ezusb-exit-hook.md): For IIDX with ezusb IO
+  * [iidx-bio2-exit-hook](doc/tools/iidx-bio2-exit-hook.md): For IIDX with BIO2 IO
+  * [iidx-ezusb2-exit-hook](doc/tools/iidx-ezusb-exit-hook.md): For IIDX with ezusb FX2 IO
+* Bemanitools API testing: Tools for testing bemanitools API implementations
+  * [ddriotest](doc/tools/ddriotest.md): For [ddrio API](doc/api.md#io-boards)
+  * [eamiotest](doc/tools/eamiotest.md): For [eamio API](doc/api.md#eamuse-readers)
+  * [iidxiotest](doc/tools/iidxiotest.md): For [iidxio API](doc/api.md#io-boards)
+  * [jbiotest](doc/tools/jbiotest.md): For [jbio API](doc/api.md#io-boards)
+* DDR IO testing: Tools for testing hardware of a real DDR cabinet
+  * [p3io-ddr-tool](doc/tools/p3io-ddr-tool.md)
+  * [extiotest](doc/tools/extiotest.md)
+* [aciotest](doc/tools/aciotest.md): Command line tool to quickly test ACIO devices
+* config: UI input/output configuration tool when using the default bemanitools API (geninput)
+* ir-beat-patch-9/10: Patch the IR beat phase on IIDX 9 and 10
+* [mempatch-hook](doc/tools/mempatch-hook.md): Patch raw memory locations in the target process based on the provided
+  configuration
+* [pcbidgen](doc/tools/pcbidgen.md): Konami PCBID generator tool
+* [ViGEm clients](doc/vigem/README.md): Expose BT5 APIs as XBOX game controllers to play any games with real cabinet
+  hardware.
 
-See the dedicated [readme](doc/vigem/README.md) for details.
+## Pre-requisites
 
-## Supported platforms
+### Supported platforms
 Our main platforms are currently Windows XP and Windows 7 which are also the target platforms on the original hardware
 of those games. However, as it gets more difficult to get and maintain hardware comptible with Windows XP, this might
 change in the future. Many games also run on very recent Windows 10 builds but bear with us that it's hard to keep up
 with Windows updates breaking legacy software.
 
-## Distribution contents
+### Distribution contents
 Check the [list of supported games](#supported-games) to grab the right files for your game. BT5 also includes
 a *tools* subpackage (tools.zip) as well as the full source code (src.zip).
 
@@ -104,15 +133,22 @@ You will find *.md files in various sub-packages that give you further instructi
 or FAQ. We advice you to read them as your questions and concerns might already be answered by them. If not, let us
 know if there is any information that you consider helpful or important to know and should be added.
 
-## Setup and dependencies
+### Setup and dependencies
 Most (older generation) games were developed for Windows XP Embedded but should run fine on any
 consumer version of Windows XP. Newer versions of Windows, e.g. Windows 7, 8 and 10, should be fine
 as well. Some hooks also include fixes required to run the games on a more recent version.
 
 Depending on the game, you also need the following dependencies installed:
-* DirectX 9 runtime
+
-* Microsoft Visual C++ Redistributables 2010 **and** 2013: Depends on the game and age but both
+* The 32-bit (x86) version of
-should cover most if not all of the games so far
+  [Microsoft Visual C++ 2010 Service Pack 1 Redistributable Package MFC Security Update](https://www.microsoft.com/en-sg/download/details.aspx?id=26999)
+* The 32-bit (x86) and 64-bit (x64) versions of
+  [Microsoft Visual C++ Redistributable Packages for Visual Studio 2013](https://www.microsoft.com/en-sg/download/details.aspx?id=40784)
+* The [DirectX 9 End-User Runtimes (June 2010)](https://www.microsoft.com/en-us/download/details.aspx?id=8109)
+
+See also
+[bemanitools-supplement](https://www.github.com/djhackersdev/bemanitools-supplement/)
+for files.
 
 ## Development
 ### Building
@@ -126,32 +162,7 @@ important aspects you should know before you get started with development.
 Please refer to the [API documentation](doc/api.md).
 
 ## Release process
-Steps for the release process:
+Please refer to the [dedicated documentation](doc/release-process.md).
-1. Update the corresponding section in the [changelog](CHANGELOG.md) with bullet points reflecting
-major features merged into master since the previous release
-1. Make sure you have the latest `master` state pulled to your local copy
-1. Tag the release with the next release number which also be found at the
-[top of the readme](#bemanitools-5) as it always reflects the current version beinged worked on
-on the `master` branch , e.g. 5.35: `git tag 5.35`
-1. Push the tag to upstream: `git push origin 5.35`
-1. The [build pipeline](https://dev.s-ul.net/djhackers/bemanitools/-/pipelines) should start
-automatically once the tag is pushed including the steps `build` and `upload-release`
-1. Once completed successfully, the release is uploaded
-1. Take the changelog of the published version and notify the pigs in the stall about it:
-    1. New post in thread
-        ```
-        <insert version here> released: <direct link to published version>
-
-        Changelog:
-        <paste changelog here>
-        ```
-    1. Update the OP title by bumping the version number in it
-    1. Update the OP post by extending it accordingly (see previous entries)
-
-1. Bump the version number at the [top of this readme](#bemanitools-5) and add a new empty section
-in the [changelog](CHANGELOG.md) with the new version number as title. Commit changes and push to
-`master` branch
-1. Continue developing and merging MRs until you decide its time for another release
 
 ## License
 Source code license is the Unlicense; you are permitted to do with this as thou wilt. For details, please refer to the

dist/iidx/gamestart-18-cn.bat

@@ -0,0 +1,17 @@
+@echo off
+
+cd /d %~dp0
+
+if not exist d mkdir d
+if not exist e mkdir e
+if not exist f mkdir f
+
+if not exist e\avs_conf mkdir e\avs_conf
+if not exist e\avs_conf\CONF mkdir e\avs_conf\CONF
+if not exist e\avs_conf\CONF\NVRAM mkdir e\avs_conf\CONF\NVRAM
+if not exist e\avs_conf\CONF\RAW mkdir e\avs_conf\CONF\RAW
+
+if not exist dev\nvram mkdir dev\nvram
+if not exist dev\raw mkdir dev\raw
+
+inject iidxhook4-cn.dll bm2dx.exe -D --config iidxhook-18-cn.conf %*

dist/iidx/gamestart-20-cn.bat

@@ -11,4 +11,7 @@ if not exist e\avs_conf\CONF mkdir e\avs_conf\CONF
 if not exist e\avs_conf\CONF\NVRAM mkdir e\avs_conf\CONF\NVRAM
 if not exist e\avs_conf\CONF\RAW mkdir e\avs_conf\CONF\RAW
 
+if not exist dev\nvram mkdir dev\nvram
+if not exist dev\raw mkdir dev\raw
+
 inject iidxhook5-cn.dll bm2dx.exe -D --config iidxhook-20-cn.conf %*

dist/iidx/gamestart-29.bat

@@ -0,0 +1,16 @@
+@echo off
+cd /d %~dp0
+
+if not exist dev mkdir dev
+if not exist dev\e mkdir dev\e
+if not exist dev\g mkdir dev\g
+if not exist dev\nvram mkdir dev\nvram
+if not exist dev\raw mkdir dev\raw
+if not exist dev\raw\log mkdir dev\raw\log
+if not exist dev\raw\fscache mkdir dev\raw\fscache
+
+for /R prop\defaults %%D in (*.*) do (
+    if not exist dev\nvram\%%~nxD copy /y prop\defaults\%%~nxD dev\nvram
+)
+
+launcher -H 134217728 -B iidxhook9.dll bm2dx.dll --config iidxhook-29.conf %*

dist/iidx/gamestart-30.bat

@@ -0,0 +1,16 @@
+@echo off
+cd /d %~dp0
+
+if not exist dev mkdir dev
+if not exist dev\e mkdir dev\e
+if not exist dev\g mkdir dev\g
+if not exist dev\nvram mkdir dev\nvram
+if not exist dev\raw mkdir dev\raw
+if not exist dev\raw\log mkdir dev\raw\log
+if not exist dev\raw\fscache mkdir dev\raw\fscache
+
+for /R prop\defaults %%D in (*.*) do (
+    if not exist dev\nvram\%%~nxD copy /y prop\defaults\%%~nxD dev\nvram
+)
+
+modules\launcher -H 134217728 -B iidxhook9.dll bm2dx.dll --config iidxhook-30.conf %*

dist/iidx/iidx-irbeat-patch-09.bat

@@ -1,12 +1,45 @@
 @echo off
+cd /d %~dp0
 
-IF "%1"=="" GOTO USAGE
+REM Open menu if no arguments specified
+if "%~1" == "" goto menu
 
-iidx-irbeat-patch.exe 9 %1 e\\settings.bin.0
+if "%~1" gtr "3" goto badbeat
-iidx-irbeat-patch.exe 9 %1 f\\settings.bin.1
+if "%~1" == "0" goto badbeat
-GOTO END
 
-:USAGE
+set beat = "%~1" - 1
-	ECHO "Usage: iidx-irbeat-patch.bat <beat phase>"
+iidx-irbeat-patch.exe 9 %beat% e\\settings.bin.0
+iidx-irbeat-patch.exe 9 %beat% f\\settings.bin.1
+
+if not errorlevel 0 goto error
+echo Beat phase patched sucessfully
+exit /b
+
+:menu
+echo Select beat phase:
+echo 1 - beat#1
+echo 2 - beat#2
+echo 3 - beat#3
+
+choice /n /c:123
+set /a beat = %errorlevel% - 1
+
+echo.
+iidx-irbeat-patch.exe 9 %beat% e\\settings.bin.0
+iidx-irbeat-patch.exe 9 %beat% f\\settings.bin.1
+echo.
+
+if not errorlevel 0 goto error
+echo Beat phase patched sucessfully
+timeout 5
+exit /b
+
+:error
+echo Something has gone wrong with the patching process, have you run the game at least once?
+pause
+exit /b
+
+:badbeat
+echo Invalid beat phase specified, values are 1 to 3.
+exit /b
 
-:END

dist/iidx/iidx-irbeat-patch-10.bat

@@ -1,12 +1,45 @@
 @echo off
+cd /d %~dp0
 
-IF "%1"=="" GOTO USAGE
+REM Open menu if no arguments specified
+if "%~1" == "" goto menu
 
-iidx-irbeat-patch.exe 10 %1 e\\settings.bin.0
+if %~1 gtr 3 goto badbeat
-iidx-irbeat-patch.exe 10 %1 f\\settings.bin.1
+if %~1 == 0 goto badbeat
-GOTO END
 
-:USAGE
+set /a beat = %~1 - 1
-	ECHO "Usage: iidx-irbeat-patch.bat <beat phase>"
+iidx-irbeat-patch.exe 9 %beat% e\\settings.bin.0
+iidx-irbeat-patch.exe 9 %beat% f\\settings.bin.1
+
+if not errorlevel 0 goto error
+echo Beat phase patched sucessfully
+exit /b
+
+:menu
+echo Select beat phase:
+echo 1 - beat#1
+echo 2 - beat#2
+echo 3 - beat#3
+
+choice /n /c:123
+set /a beat = %errorlevel% - 1
+
+echo.
+iidx-irbeat-patch.exe 10 %beat% e\\settings.bin.0
+iidx-irbeat-patch.exe 10 %beat% f\\settings.bin.1
+echo.
+
+if not errorlevel 0 goto error
+echo Beat phase patched sucessfully
+timeout 5
+exit /b
+
+:error
+echo Something has gone wrong with the patching process, have you run the game at least once?
+pause
+exit /b
+
+:badbeat
+echo Invalid beat phase specified, values are 1 to 3.
+exit /b
 
-:END

dist/iidx/iidxhook-09.conf

@@ -10,7 +10,7 @@ eamuse.pcbid=0101020304050607086F
 # EAMID
 eamuse.eamid=0101020304050607086F
 
-# Fix stretched BG videos on newer GPUs. Might appear on Red and newer
+# Fix stretched BG videos on newer GPUs. Might appear on SIRIUS and older. On 9th and 10th style this issue may only affect older BGAs (from 1st-3rd style)
 gfx.bgvideo_uv_fix=false
 
 # Run the game in a framed window (requires windowed option)
@@ -46,17 +46,26 @@ gfx.forced_refresh_rate=-1
 # D3D9 device adapter (monitor), -1 to use default, 0, 1, 2 etc. to use specified adapter
 gfx.device_adapter=-1
 
+# Enable monitoring of ezusb.dll calls by logging call traces. Only works on 9th and 10th style!
+ezusb.api_call_monitoring=false
+
+# Set the type of ezusb IO board. 0 = C02, 1 = D01. Note: Impacts security settings!
+ezusb.io_board_type=0
+
 # Disable operator clock setting system clock time
 misc.disable_clock_set=false
 
 # Stub calls to rteffect.dll (10th to DistorteD)
 misc.rteffect_stub=false
 
+# Path to store the settings, e.g. bookkeeping, operator settings. d:, e: and f: drive configuration/settings data
+misc.settings_path=.\
+
 # Security boot version (e.g. GEC02).
 sec.boot_version=GEC02   
 
 # Security boot seeds for ezusb, format: X:X:X where X is a number of 0-9 (e.g. 0:0:0).
 sec.boot_seeds=0:0:0
 
-# Security black plug mcode id string (e.g. GQC02JAA).
+# Security black plug mcode id string (e.g. GEC02JAA).
-sec.black_plug_mcode=GQC02JAA
+sec.black_plug_mcode=GEC02JAA

dist/iidx/iidxhook-10.conf

@@ -10,7 +10,7 @@ eamuse.pcbid=0101020304050607086F
 # EAMID
 eamuse.eamid=0101020304050607086F
 
-# Fix stretched BG videos on newer GPUs. Might appear on Red and newer
+# Fix stretched BG videos on newer GPUs. Might appear on SIRIUS and older. On 9th and 10th style this issue may only affect older BGAs (from 1st-3rd style)
 gfx.bgvideo_uv_fix=false
 
 # Run the game in a framed window (requires windowed option)
@@ -46,12 +46,21 @@ gfx.forced_refresh_rate=-1
 # D3D9 device adapter (monitor), -1 to use default, 0, 1, 2 etc. to use specified adapter
 gfx.device_adapter=-1
 
+# Enable monitoring of ezusb.dll calls by logging call traces. Only works on 9th and 10th style!
+ezusb.api_call_monitoring=false
+
+# Set the type of ezusb IO board. 0 = C02, 1 = D01. Note: Impacts security settings!
+ezusb.io_board_type=1
+
 # Disable operator clock setting system clock time
 misc.disable_clock_set=false
 
 # Stub calls to rteffect.dll (10th to DistorteD)
 misc.rteffect_stub=false
 
+# Path to store the settings, e.g. bookkeeping, operator settings. d:, e: and f: drive configuration/settings data
+misc.settings_path=.\
+
 # Security boot version (e.g. GEC02).
 sec.boot_version=GEC02   
 

dist/iidx/iidxhook-11.conf

@@ -10,7 +10,7 @@ eamuse.pcbid=0101020304050607086F
 # EAMID
 eamuse.eamid=0101020304050607086F
 
-# Fix stretched BG videos on newer GPUs. Might appear on Red and newer
+# Fix stretched BG videos on newer GPUs. Might appear on SIRIUS and older. On 9th and 10th style this issue may only affect older BGAs (from 1st-3rd style)
 gfx.bgvideo_uv_fix=false
 
 # Run the game in a framed window (requires windowed option)
@@ -46,12 +46,21 @@ gfx.forced_refresh_rate=-1
 # D3D9 device adapter (monitor), -1 to use default, 0, 1, 2 etc. to use specified adapter
 gfx.device_adapter=-1
 
+# Enable monitoring of ezusb.dll calls by logging call traces. Only works on 9th and 10th style!
+ezusb.api_call_monitoring=false
+
+# Set the type of ezusb IO board. 0 = C02, 1 = D01. Note: Impacts security settings!
+ezusb.io_board_type=1
+
 # Disable operator clock setting system clock time
 misc.disable_clock_set=false
 
 # Stub calls to rteffect.dll (10th to DistorteD)
 misc.rteffect_stub=false
 
+# Path to store the settings, e.g. bookkeeping, operator settings. d:, e: and f: drive configuration/settings data
+misc.settings_path=.\
+
 # Security boot version (e.g. GEC02).
 sec.boot_version=GEC02   
 

dist/iidx/iidxhook-12.conf

@@ -10,7 +10,7 @@ eamuse.pcbid=0101020304050607086F
 # EAMID
 eamuse.eamid=0101020304050607086F
 
-# Fix stretched BG videos on newer GPUs. Might appear on Red and newer
+# Fix stretched BG videos on newer GPUs. Might appear on SIRIUS and older. On 9th and 10th style this issue may only affect older BGAs (from 1st-3rd style)
 gfx.bgvideo_uv_fix=false
 
 # Run the game in a framed window (requires windowed option)
@@ -46,6 +46,12 @@ gfx.forced_refresh_rate=-1
 # D3D9 device adapter (monitor), -1 to use default, 0, 1, 2 etc. to use specified adapter
 gfx.device_adapter=-1
 
+# Enable monitoring of ezusb.dll calls by logging call traces. Only works on 9th and 10th style!
+ezusb.api_call_monitoring=false
+
+# Set the type of ezusb IO board. 0 = C02, 1 = D01. Note: Impacts security settings!
+ezusb.io_board_type=1
+
 # Fix broken 3D background on Happy Sky's music select (if appearing completely white)
 misc.happy_sky_ms_bg_fix=false
 
@@ -55,6 +61,9 @@ misc.disable_clock_set=false
 # Stub calls to rteffect.dll (10th to DistorteD)
 misc.rteffect_stub=false
 
+# Path to store the settings, e.g. bookkeeping, operator settings. d:, e: and f: drive configuration/settings data
+misc.settings_path=.\
+
 # Security boot version (e.g. GEC02).
 sec.boot_version=GEC02   
 

dist/iidx/iidxhook-13.conf

@@ -10,7 +10,7 @@ eamuse.pcbid=0101020304050607086F
 # EAMID
 eamuse.eamid=0101020304050607086F
 
-# Fix stretched BG videos on newer GPUs. Might appear on Red and newer
+# Fix stretched BG videos on newer GPUs. Might appear on SIRIUS and older. On 9th and 10th style this issue may only affect older BGAs (from 1st-3rd style)
 gfx.bgvideo_uv_fix=false
 
 # Run the game in a framed window (requires windowed option)
@@ -46,6 +46,12 @@ gfx.forced_refresh_rate=-1
 # D3D9 device adapter (monitor), -1 to use default, 0, 1, 2 etc. to use specified adapter
 gfx.device_adapter=-1
 
+# Enable monitoring of ezusb.dll calls by logging call traces. Only works on 9th and 10th style!
+ezusb.api_call_monitoring=false
+
+# Set the type of ezusb IO board. 0 = C02, 1 = D01. Note: Impacts security settings!
+ezusb.io_board_type=1
+
 # Fix broken 3D background on DistorteD's music select (if appearing completely black)
 misc.distorted_ms_bg_fix=false
 
@@ -55,6 +61,9 @@ misc.disable_clock_set=false
 # Stub calls to rteffect.dll (10th to DistorteD)
 misc.rteffect_stub=false
 
+# Path to store the settings, e.g. bookkeeping, operator settings. d:, e: and f: drive configuration/settings data
+misc.settings_path=.\
+
 # Security boot version (e.g. GEC02).
 sec.boot_version=GEC02   
 

dist/iidx/iidxhook-14.conf

@@ -7,7 +7,7 @@ eamuse.pcbid=0101020304050607086F
 # EAMID
 eamuse.eamid=0101020304050607086F
 
-# Fix stretched BG videos on newer GPUs. Might appear on Red and newer
+# Fix stretched BG videos on newer GPUs. Might appear on SIRIUS and older. On 9th and 10th style this issue may only affect older BGAs (from 1st-3rd style)
 gfx.bgvideo_uv_fix=false
 
 # Run the game in a framed window (requires windowed option)
@@ -46,5 +46,8 @@ gfx.device_adapter=-1
 # Disable operator clock setting system clock time
 misc.disable_clock_set=false
 
+# Path to store the settings, e.g. bookkeeping, operator settings. d:, e: and f: drive configuration/settings data
+misc.settings_path=.\
+
 # Security black plug mcode id string (e.g. GQC02JAA).
 sec.black_plug_mcode=GQGLDJAA

dist/iidx/iidxhook-15.conf

@@ -7,7 +7,7 @@ eamuse.pcbid=0101020304050607086F
 # EAMID
 eamuse.eamid=0101020304050607086F
 
-# Fix stretched BG videos on newer GPUs. Might appear on Red and newer
+# Fix stretched BG videos on newer GPUs. Might appear on SIRIUS and older. On 9th and 10th style this issue may only affect older BGAs (from 1st-3rd style)
 gfx.bgvideo_uv_fix=false
 
 # Run the game in a framed window (requires windowed option)
@@ -46,5 +46,8 @@ gfx.device_adapter=-1
 # Disable operator clock setting system clock time
 misc.disable_clock_set=false
 
+# Path to store the settings, e.g. bookkeeping, operator settings. d:, e: and f: drive configuration/settings data
+misc.settings_path=.\
+
 # Security black plug mcode id string (e.g. GQC02JAA).
 sec.black_plug_mcode=GQHDDJAA

dist/iidx/iidxhook-16.conf

@@ -7,7 +7,7 @@ eamuse.pcbid=0101020304050607086F
 # EAMID
 eamuse.eamid=0101020304050607086F
 
-# Fix stretched BG videos on newer GPUs. Might appear on Red and newer
+# Fix stretched BG videos on newer GPUs. Might appear on SIRIUS and older. On 9th and 10th style this issue may only affect older BGAs (from 1st-3rd style)
 gfx.bgvideo_uv_fix=false
 
 # Run the game in a framed window (requires windowed option)
@@ -49,5 +49,8 @@ gfx.device_adapter=-1
 # Disable operator clock setting system clock time
 misc.disable_clock_set=false
 
+# Path to store the settings, e.g. bookkeeping, operator settings. d:, e: and f: drive configuration/settings data
+misc.settings_path=.\
+
 # Security black plug mcode id string (e.g. GQC02JAA).
 sec.black_plug_mcode=GQI00JAA

dist/iidx/iidxhook-17.conf

@@ -7,7 +7,7 @@ eamuse.pcbid=0101020304050607086F
 # EAMID
 eamuse.eamid=0101020304050607086F
 
-# Fix stretched BG videos on newer GPUs. Might appear on Red and newer
+# Fix stretched BG videos on newer GPUs. Might appear on SIRIUS and older. On 9th and 10th style this issue may only affect older BGAs (from 1st-3rd style)
 gfx.bgvideo_uv_fix=false
 
 # Run the game in a framed window (requires windowed option)
@@ -49,5 +49,8 @@ gfx.device_adapter=-1
 # Disable operator clock setting system clock time
 misc.disable_clock_set=false
 
+# Path to store the settings, e.g. bookkeeping, operator settings. d:, e: and f: drive configuration/settings data
+misc.settings_path=.\
+
 # Security black plug mcode id string (e.g. GQC02JAA).
 sec.black_plug_mcode=GCJDJJAA

dist/iidx/iidxhook-18-cn.conf

@@ -0,0 +1,50 @@
+# PCBID
+eamuse.pcbid=0101020304050607086F
+
+# Run the game in a framed window (requires windowed option)
+gfx.framed=false
+
+# Software limit the frame rate of the rendering loop in hz, e.g. 60 or 59.95 (0.0 = no software limit)
+gfx.frame_rate_limit=0.0
+
+# Enable/disable software monitor check/auto timebase or set a pre-determined refresh value. -1 disables this feature. 0 enables auto detecting the current refresh rate on startup. Setting any positive value > 0 allows you to set a pre-determined refresh rate (e.g. retrieved from the monitor check on newer IIDX games). Either the auto detected value or pre-determined value is used to patch any chart files in-memory to fix song synchronization issues. Requires constant refresh rate!!!
+gfx.monitor_check=-1.000000
+
+# Patch the GPU device ID detection (leave empty to disable), format XXXX:YYYY, two 4 digit hex numbers (vid:pid). Examples: 1002:7146 (RV515, Radeon X1300), 1002:95C5 (RV620 LE, Radeon HD3450)
+gfx.pci_id=1002:7146
+
+# Run the game windowed
+gfx.windowed=false
+
+# Windowed width, 0 for default size
+gfx.window_width=0
+
+# Windowed height, 0 for default size
+gfx.window_height=0
+
+# Up-/downscale the back buffer's width. This does not change the game's rendering resolution but scales the final frame. Use this to target the native resolution of your monitor/TV, e.g. to avoid over-/underscan, bad image quality or latency caused by the monitors internal upscaler. 0 to disable this feature. Must be set in combination with the corresponding height parameter.
+gfx.scale_back_buffer_width=0
+
+# Up-/downscale the back buffer's height. This does not change the game's rendering resolution but scales the final frame. Use this to target the native resolution of your monitor/TV, e.g. to avoid over-/underscan, bad image quality or latency caused by the monitors internal upscaler. 0 to disable this feature. Must be set in combination with the corresponding width parameter.
+gfx.scale_back_buffer_height=0
+
+# Filter type to use for up-/downscaling the back buffer. Only used if scaling feature was enabled by setting the scaling width and height parameters. Available types: none, linear, point (refer to D3DTEXTUREFILTERTYPE  for explanation).
+gfx.scale_back_buffer_filter=none
+
+# Forced refresh rate, -1 to not force any (try 59 or 60 if monitor check fails to lock on high refresh rate monitors)
+gfx.forced_refresh_rate=-1
+
+# D3D9 device adapter (monitor), -1 to use default, 0, 1, 2 etc. to use specified adapter
+gfx.device_adapter=-1
+
+# Fix diagonal tearing with video cards other than Radeon X1300 and HD3450
+gfx.diagonal_tearing_fix=false
+
+# Disable ezusb IO emulation and enable usage of real ezusb1/2 IO hardware
+io.disable_io_emu=false
+
+# Path to store the settings, e.g. bookkeeping, operator settings. d:, e: and f: drive configuration/settings data
+misc.settings_path=.\
+
+# Security black plug mcode id string (e.g. GQC02JAA).
+sec.black_plug_mcode=GKJDZCAA

dist/iidx/iidxhook-18.conf

@@ -1,6 +1,3 @@
-# Fix stretched BG videos on newer GPUs. Might appear on Red and newer
-gfx.bgvideo_uv_fix=false
-
 # Run the game in a framed window (requires windowed option)
 gfx.framed=false
 
@@ -37,8 +34,14 @@ gfx.forced_refresh_rate=-1
 # D3D9 device adapter (monitor), -1 to use default, 0, 1, 2 etc. to use specified adapter
 gfx.device_adapter=-1
 
+# Fix diagonal tearing with video cards other than Radeon X1300 and HD3450
+gfx.diagonal_tearing_fix=false
+
 # Disable card reader emulation and enable usage of real card reader hardware on COM1 (for games supporting slotted/wavepass readers)
 io.disable_card_reader_emu=false
 
 # Disable ezusb IO emulation and enable usage of real ezusb1/2 IO hardware
-io.disable_io_emu=false
+io.disable_io_emu=false
+
+# Path to store the settings, e.g. bookkeeping, operator settings. d:, e: and f: drive configuration/settings data
+misc.settings_path=.\

dist/iidx/iidxhook-19.conf

@@ -1,12 +1,12 @@
-# Fix stretched BG videos on newer GPUs. Might appear on Red and newer
-gfx.bgvideo_uv_fix=false
-
 # Run the game in a framed window (requires windowed option)
 gfx.framed=false
 
 # Software limit the frame rate of the rendering loop in hz, e.g. 60 or 59.95 (0.0 = no software limit)
 gfx.frame_rate_limit=0.0
 
+# Enable/disable software monitor check/auto timebase or set a pre-determined refresh value. -1 disables this feature. 0 enables auto detecting the current refresh rate on startup. Setting any positive value > 0 allows you to set a pre-determined refresh rate (e.g. retrieved from the monitor check on newer IIDX games). Either the auto detected value or pre-determined value is used to patch any chart files in-memory to fix song synchronization issues. Requires constant refresh rate!!!
+gfx.monitor_check=-1.000000
+
 # Patch the GPU device ID detection (leave empty to disable), format XXXX:YYYY, two 4 digit hex numbers (vid:pid). Examples: 1002:7146 (RV515, Radeon X1300), 1002:95C5 (RV620 LE, Radeon HD3450)
 gfx.pci_id=1002:7146
 
@@ -34,8 +34,14 @@ gfx.forced_refresh_rate=-1
 # D3D9 device adapter (monitor), -1 to use default, 0, 1, 2 etc. to use specified adapter
 gfx.device_adapter=-1
 
+# Fix diagonal tearing with video cards other than Radeon X1300 and HD3450
+gfx.diagonal_tearing_fix=false
+
 # Disable card reader emulation and enable usage of real card reader hardware on COM1 (for games supporting slotted/wavepass readers)
 io.disable_card_reader_emu=false
 
 # Disable ezusb IO emulation and enable usage of real ezusb1/2 IO hardware
-io.disable_io_emu=false
+io.disable_io_emu=false
+
+# Path to store the settings, e.g. bookkeeping, operator settings. d:, e: and f: drive configuration/settings data
+misc.settings_path=.\

dist/iidx/iidxhook-20-cn.conf

@@ -1,9 +1,6 @@
 # PCBID
 eamuse.pcbid=0101020304050607086F
 
-# Fix stretched BG videos on newer GPUs. Might appear on Red and newer
-gfx.bgvideo_uv_fix=false
-
 # Run the game in a framed window (requires windowed option)
 gfx.framed=false
 
@@ -37,8 +34,14 @@ gfx.forced_refresh_rate=-1
 # D3D9 device adapter (monitor), -1 to use default, 0, 1, 2 etc. to use specified adapter
 gfx.device_adapter=-1
 
+# Fix diagonal tearing with video cards other than Radeon X1300 and HD3450
+gfx.diagonal_tearing_fix=false
+
 # Disable ezusb IO emulation and enable usage of real ezusb1/2 IO hardware
 io.disable_io_emu=false
 
+# Path to store the settings, e.g. bookkeeping, operator settings. d:, e: and f: drive configuration/settings data
+misc.settings_path=.\
+
 # Security black plug mcode id string (e.g. GQC02JAA).
 sec.black_plug_mcode=GKJDZCAA

dist/iidx/iidxhook-20.conf

@@ -1,6 +1,3 @@
-# Fix stretched BG videos on newer GPUs. Might appear on Red and newer
-gfx.bgvideo_uv_fix=false
-
 # Run the game in a framed window (requires windowed option)
 gfx.framed=false
 

dist/iidx/iidxhook-21.conf

@@ -1,6 +1,3 @@
-# Fix stretched BG videos on newer GPUs. Might appear on Red and newer
-gfx.bgvideo_uv_fix=false
-
 # Run the game in a framed window (requires windowed option)
 gfx.framed=false
 

dist/iidx/iidxhook-22.conf

@@ -1,6 +1,3 @@
-# Fix stretched BG videos on newer GPUs. Might appear on Red and newer
-gfx.bgvideo_uv_fix=false
-
 # Run the game in a framed window (requires windowed option)
 gfx.framed=false
 

dist/iidx/iidxhook-23.conf

@@ -1,6 +1,3 @@
-# Fix stretched BG videos on newer GPUs. Might appear on Red and newer
-gfx.bgvideo_uv_fix=false
-
 # Run the game in a framed window (requires windowed option)
 gfx.framed=false
 

dist/iidx/iidxhook-24.conf

@@ -1,6 +1,3 @@
-# Fix stretched BG videos on newer GPUs. Might appear on Red and newer
-gfx.bgvideo_uv_fix=false
-
 # Run the game in a framed window (requires windowed option)
 gfx.framed=false
 

dist/iidx/iidxhook-25.conf

@@ -1,6 +1,3 @@
-# Fix stretched BG videos on newer GPUs. Might appear on Red and newer
-gfx.bgvideo_uv_fix=false
-
 # Run the game in a framed window (requires windowed option)
 gfx.framed=false
 
@@ -37,17 +34,23 @@ gfx.device_adapter=-1
 # Disables the camera emulation
 cam.disable_emu=false
 
-# Override camera device ID 1 detection (copy from device manager, do not escape)
+# Disable camera 1. Use, i.e., if you only have one camera and want it to be mapped to camera 2 ingame.
+cam.disable_camera1=false
+
+# Disable camera 2. Use, i.e., if you have more than one camera but only want to map camera 1 ingame.
+cam.disable_camera2=false
+
+# Override camera device ID 1 detection (copy from device manager, do not escape) Leave blank to automatically detect
 cam.device_id1=
 
-# Override camera device ID 2 detection (copy from device manager, do not escape)
+# Override camera device ID 2 detection (copy from device manager, do not escape) Leave blank to automatically detect
 cam.device_id2=
 
-# Disable card reader emulation and enable usage of real card reader hardware on COM0 (for games supporting slotted readers)
+# Disable card reader emulation and enable usage of real card reader hardware on COM1 (for games supporting slotted readers)
 io.disable_card_reader_emu=false
 
 # Disable BIO2 emulation and enable usage of real BIO2 hardware
 io.disable_bio2_emu=false
 
 # Disables the poll limiter, warning very high CPU usage may arise
-io.disable_poll_limiter=false
+io.disable_poll_limiter=false

dist/iidx/iidxhook-26.conf

@@ -1,6 +1,3 @@
-# Fix stretched BG videos on newer GPUs. Might appear on Red and newer
-gfx.bgvideo_uv_fix=false
-
 # Run the game in a framed window (requires windowed option)
 gfx.framed=false
 
@@ -37,17 +34,23 @@ gfx.device_adapter=-1
 # Disables the camera emulation
 cam.disable_emu=false
 
-# Override camera device ID 1 detection (copy from device manager, do not escape)
+# Disable camera 1. Use, i.e., if you only have one camera and want it to be mapped to camera 2 ingame.
+cam.disable_camera1=false
+
+# Disable camera 2. Use, i.e., if you have more than one camera but only want to map camera 1 ingame.
+cam.disable_camera2=false
+
+# Override camera device ID 1 detection (copy from device manager, do not escape) Leave blank to automatically detect
 cam.device_id1=
 
-# Override camera device ID 2 detection (copy from device manager, do not escape)
+# Override camera device ID 2 detection (copy from device manager, do not escape) Leave blank to automatically detect
 cam.device_id2=
 
-# Disable card reader emulation and enable usage of real card reader hardware on COM0 (for games supporting slotted readers)
+# Disable card reader emulation and enable usage of real card reader hardware on COM1 (for games supporting slotted readers)
 io.disable_card_reader_emu=false
 
 # Disable BIO2 emulation and enable usage of real BIO2 hardware
 io.disable_bio2_emu=false
 
 # Disables the poll limiter, warning very high CPU usage may arise
-io.disable_poll_limiter=false
+io.disable_poll_limiter=false

dist/iidx/iidxhook-27.conf

@@ -1,4 +1,4 @@
-# Disable card reader emulation and enable usage of real card reader hardware on COM0 (for games supporting slotted readers)
+# Disable card reader emulation and enable usage of real card reader hardware on COM1 (for games supporting slotted readers)
 io.disable_card_reader_emu=false
 
 # Disable BIO2 emulation and enable usage of real BIO2 hardware
@@ -11,7 +11,7 @@ io.disable_poll_limiter=false
 io.lightning_mode=false
 
 # Disable camera connection
-io.disable_cams=false
+io.disable_cams=true
 
 # Disables the built in file hooks, requiring manual file creation
 io.disable_file_hooks=false
@@ -20,7 +20,13 @@ io.disable_file_hooks=false
 io.tt_multiplier=1.0
 
 # Disables the camera emulation
-cam.disable_emu=false
+cam.disable_emu=true
+
+# Disable camera 1. Use, i.e., if you only have one camera and want it to be mapped to camera 2 ingame.
+cam.disable_camera1=false
+
+# Disable camera 2. Use, i.e., if you have more than one camera but only want to map camera 1 ingame.
+cam.disable_camera2=false
 
 # Override camera device ID detection (copy from device manager, do not escape)
 cam.device_id1=

dist/iidx/iidxhook-28.conf

@@ -1,4 +1,4 @@
-# Disable card reader emulation and enable usage of real card reader hardware on COM0 (for games supporting slotted readers)
+# Disable card reader emulation and enable usage of real card reader hardware on COM1 (for games supporting slotted readers)
 io.disable_card_reader_emu=false
 
 # Disable BIO2 emulation and enable usage of real BIO2 hardware
@@ -22,6 +22,12 @@ io.tt_multiplier=1.0
 # Disables the camera emulation
 cam.disable_emu=true
 
+# Disable camera 1. Use, i.e., if you only have one camera and want it to be mapped to camera 2 ingame.
+cam.disable_camera1=false
+
+# Disable camera 2. Use, i.e., if you have more than one camera but only want to map camera 1 ingame.
+cam.disable_camera2=false
+
 # Override camera device ID detection (copy from device manager, do not escape)
 cam.device_id1=
 

dist/iidx/iidxhook-29.conf

@@ -0,0 +1,84 @@
+# Disable card reader emulation and enable usage of real card reader hardware on COM1 (for games supporting slotted readers)
+io.disable_card_reader_emu=false
+
+# Disable BIO2 emulation and enable usage of real BIO2 hardware
+io.disable_bio2_emu=false
+
+# Disables the poll limiter, warning very high CPU usage may arise
+io.disable_poll_limiter=false
+
+# Lightning cab mode (requires additional IO emulation)
+io.lightning_mode=false
+
+# Disable camera connection
+io.disable_cams=true
+
+# Disables the built in file hooks, requiring manual file creation
+io.disable_file_hooks=false
+
+# Turntable sensitivity multiplier (1.0 is default)
+io.tt_multiplier=1.0
+
+# Disables the camera emulation
+cam.disable_emu=true
+
+# Disable camera 1. Use, i.e., if you only have one camera and want it to be mapped to camera 2 ingame.
+cam.disable_camera1=true
+
+# Disable camera 2. Use, i.e., if you have more than one camera but only want to map camera 1 ingame.
+cam.disable_camera2=false
+
+# Override camera device ID detection (copy from device manager, do not escape)
+cam.device_id1=
+
+# Override camera device ID detection (copy from device manager, do not escape)
+cam.device_id2=
+
+# Run the game in a framed window (requires windowed option)
+gfx.framed=true
+
+# Run the game windowed
+gfx.windowed=false
+
+# Confine mouse cursor to window
+gfx.confined=false
+
+# Windowed width, -1 for default size
+gfx.window_width=-1
+
+# Windowed height, -1 for default size
+gfx.window_height=-1
+
+# Windowed X, -1 for default X position
+gfx.window_x=-1
+
+# Windowed Y, -1 for default Y position
+gfx.window_y=-1
+
+# Forced refresh rate, -1 to not force any (try 59 or 60 if monitor check fails to lock on high refresh rate monitors)
+gfx.forced_refresh_rate=-1
+
+# D3D9ex device adapter (monitor), -1 to use default, 0, 1, 2 etc. to use specified adapter
+gfx.device_adapter=-1
+
+# Orientation to force monitor into, -1 to use default, 0, 1, 2, 3 to do 0, 90, 180, 270 degrees
+gfx.force_orientation=-1
+
+# Force a screen resolution (width), -1 to disable. Use this if the game does not auto detect your monitor's resolution properly, e.g. 1368x768 instead of 1280x720.
+gfx.force_screen_res.width=-1
+
+# Force a screen resolution (height), -1 to disable. Use this if the game does not auto detect your monitor's resolution properly, e.g. 1368x768 instead of 1280x720.
+gfx.force_screen_res.height=-1
+
+# IP of adapter to force override with
+adapter.override_ip=
+
+# Force ASIO audio mode/device (if applicable / TDJ default)
+asio.force_asio=false
+
+# Force WASAPI audio mode (if applicable / LDJ default)
+asio.force_wasapi=true
+
+# The ASIO device name to use
+asio.device_name=XONAR SOUND CARD(64)
+

dist/iidx/iidxhook-30.conf

@@ -0,0 +1,84 @@
+# Disable card reader emulation and enable usage of real card reader hardware on COM1 (for games supporting slotted readers)
+io.disable_card_reader_emu=false
+
+# Disable BIO2 emulation and enable usage of real BIO2 hardware
+io.disable_bio2_emu=false
+
+# Disables the poll limiter, warning very high CPU usage may arise
+io.disable_poll_limiter=false
+
+# Lightning cab mode (requires additional IO emulation)
+io.lightning_mode=false
+
+# Disable camera connection
+io.disable_cams=true
+
+# Disables the built in file hooks, requiring manual file creation
+io.disable_file_hooks=false
+
+# Turntable sensitivity multiplier (1.0 is default)
+io.tt_multiplier=1.0
+
+# Disables the camera emulation
+cam.disable_emu=true
+
+# Disable camera 1. Use, i.e., if you only have one camera and want it to be mapped to camera 2 ingame.
+cam.disable_camera1=true
+
+# Disable camera 2. Use, i.e., if you have more than one camera but only want to map camera 1 ingame.
+cam.disable_camera2=false
+
+# Override camera device ID detection (copy from device manager, do not escape)
+cam.device_id1=
+
+# Override camera device ID detection (copy from device manager, do not escape)
+cam.device_id2=
+
+# Run the game in a framed window (requires windowed option)
+gfx.framed=true
+
+# Run the game windowed
+gfx.windowed=false
+
+# Confine mouse cursor to window
+gfx.confined=false
+
+# Windowed width, -1 for default size
+gfx.window_width=-1
+
+# Windowed height, -1 for default size
+gfx.window_height=-1
+
+# Windowed X, -1 for default X position
+gfx.window_x=-1
+
+# Windowed Y, -1 for default Y position
+gfx.window_y=-1
+
+# Forced refresh rate, -1 to not force any (try 59 or 60 if monitor check fails to lock on high refresh rate monitors)
+gfx.forced_refresh_rate=-1
+
+# D3D9ex device adapter (monitor), -1 to use default, 0, 1, 2 etc. to use specified adapter
+gfx.device_adapter=-1
+
+# Orientation to force monitor into, -1 to use default, 0, 1, 2, 3 to do 0, 90, 180, 270 degrees
+gfx.force_orientation=-1
+
+# Force a screen resolution (width), -1 to disable. Use this if the game does not auto detect your monitor's resolution properly, e.g. 1368x768 instead of 1280x720.
+gfx.force_screen_res.width=-1
+
+# Force a screen resolution (height), -1 to disable. Use this if the game does not auto detect your monitor's resolution properly, e.g. 1368x768 instead of 1280x720.
+gfx.force_screen_res.height=-1
+
+# IP of adapter to force override with
+adapter.override_ip=
+
+# Force ASIO audio mode/device (if applicable / TDJ default)
+asio.force_asio=false
+
+# Force WASAPI audio mode (if applicable / LDJ default)
+asio.force_wasapi=true
+
+# The ASIO device name to use
+asio.device_name=XONAR SOUND CARD(64)
+

dist/popn/config.bat

@@ -0,0 +1 @@
+@start config.exe pnm

doc/api.md

@@ -1,4 +1,5 @@
 # Bemanitools API
+
 Bemanitools introduces interfaces abstracting the IO hardware of many games. This is used to implement support for
 non-intended IO devices from simple keyboard support, standard gamecontrollers to custom IO boards or using real
 hardware with the games (e.g. support for real legacy hardware).
@@ -12,14 +13,18 @@ If you want to write an implementation for your own custom piece of hardware, ch
 sub-folder) in the source code (src.zip).
 
 ## Implementations
+
+### IO boards
+
 The following implementations are already shipped with BT5.
 
 * BeatStream
     * bstio.dll (default): Keyboard, joystick and mouse input
 * Dance Dance Revolution
     * ddrio.dll (default): Keyboard, joystick and mouse input
+    * [ddrio-p3io.dll](ddrhook/ddrio-p3io.md): DDR P3IO (Dragon PCB) + EXTIO hardware
     * ddrio-mm.dll: Minimaid hardware
-    * ddrio-smx.dll: StepManiaX platforms
+    * [ddrio-smx.dll](ddrhook/ddrio-smx.md): StepManiaX platforms
 * Beatmania IIDX
     * iidxio.dll (default): Keyboard, joystick and mouse input
     * [iidxio-bio2.dll](iidxhook/iidxio-bio2.md): BIO2 driver
@@ -34,10 +39,33 @@ The following implementations are already shipped with BT5.
     * [sdvxio-bio2.dll](sdvxhook/sdvxio-bio2.md): BIO2 driver
     * [sdvxio-kfca.dll](sdvxhook/sdvxio-kfca.md): KFCA IO board driver
 
+### Eamuse readers
+
 Eamuse hardware support is implemented separately:
+
 * eamio.dll (default): Keyboard and joystick input
+* eamio-icca.dll: Slotted/wave pass readers, required for old games with magnetic stripe cards
+
+#### ICCA readers for IIDX and port config in device manager
+
+The COM port for the card readers needs to be configured correctly in device manager. Otherwise,
+communication with the readers will fail if the settings do not align with how the game or
+bemanitools wants to operate them.
+
+Use built-in ports on your mainboard if available but an external USB to serial port dongle also
+works. 
+
+* Assign `COM1` to the COM port the card readers are connected to.
+* Ensure that the following settings for the COM port you are going to use are 
+set
+  * BAUD rate 57600
+  * Data bits 8
+  * Parity None
+  * Stop bits 1
+  * Flow control None.
 
 ## Development notes
+
 A DEF file for geninput.dll is included. To convert the DEF into an import library suitable for use with Visual C++, run
 ```
 lib /machine:i386 /def:geninput.def

doc/architecture.md

@@ -127,6 +127,15 @@ TODO go into some more detail about some differences in the hook modules, e.g. 1
 * Font patching for Japanese chars
 * Filesystem patches to detour E and F backup drives for settings
 
+#### iidxhook4-cn (18 CN)
+* Ezusb IO2 I/O emulation
+  * Setupapi emulation
+  * Full security emulation with SRAM and round plugs
+  * Full game essential I/O emulation
+* d3d9 patching and extended features
+* Font patching for Japanese chars
+* Filesystem patches to detour E and F backup drives for settings
+
 #### iidxhook5 (19)
 * Ezusb IO2 I/O emulation
     * Setupapi emulation
@@ -136,6 +145,15 @@ TODO go into some more detail about some differences in the hook modules, e.g. 1
 * Font patching for Japanese chars
 * Filesystem patches to detour E and F backup drives for settings
 
+#### iidxhook5-cn (20 CN)
+* Ezusb IO2 I/O emulation
+  * Setupapi emulation
+  * Full security emulation with SRAM and round plugs
+  * Full game essential I/O emulation
+* d3d9 patching and extended features
+* Font patching for Japanese chars
+* Filesystem patches to detour E and F backup drives for settings
+
 #### iidxhook6 (20)
 * Ezusb IO2 I/O emulation
     * Setupapi emulation

doc/ddrhook/README.md

@@ -47,3 +47,7 @@ IO hardware you want to use:
 game controllers
 * ddrio-mm: Support Minimaid custom interface
 * [ddrio-smx](ddrhook/ddrio-smx.md): Support for StepManiaX dance platforms
+
+## Unicorntail
+
+[Instructions how to run on Chimera PCBs](unicorntail.md).

doc/ddrhook/ddrhook2.md

@@ -17,6 +17,73 @@ different versions. See different distribution packages, e.g. `ddr-12.zip`,
 Depending on the game version, earlier versions are bootstrapped using
 [inject](../inject.md) while later versions require [launcher](../launcher.md).
 
+## Setup A20+
+
+### Data and folder structure
+
+The following assumes you are using vanilla and unpacked/decrypted data. Copy/unpack the data
+to a destination of your choice. Expect to have the following root folder structure:
+
+```
+arkdata
+com
+data
+dev
+modules
+prop
+```
+
+* Copy the contents of `modules` to the root folder that the dll-files are next to the folders
+  `arkdata`, `com`, etc.
+* Unpack the contents of `ddr-14-to-16.zip` to the root folder. `luncher.exe` should be located
+  next to `arkdata`, `com` and all the dll-files
+
+#### Configuring eamuse settings
+
+You need to create a `prop/ea3-config.xml` configuration file which provides properties for
+connecting to a network of your choice (and allows the game to boot).
+
+Take the `prop/eamuse.xml` as a base and make a copy of it called `prop/ea3-config.xml`.
+
+Add the software identifier as a child to the `<ea3>` parent node:
+
+```xml
+<soft>
+  <model __type="str">MDX</model>
+  <dest __type="str">J</dest>
+  <spec __type="str">A</spec>
+  <rev __type="str">A</rev>
+  <ext __type="str">2022020200</ext>
+</soft>
+```
+
+Replace the identifiers according to the version you are using.
+
+Add your PCBID as a child to the `<ea3>` parent node:
+
+```xml
+<id>
+  <pcbid __type="str">00010203040506070809</pcbid>
+  <hardid __type="str">00010203040506070809</hardid>
+</id>
+```
+
+Replace the values accordingly with your actual PCBID registered with your target network.
+
+Add network settings (note this might already exist, replace existing or delete old one) as a child
+to the `<ea3>` parent node:
+
+```xml
+<network>
+  <sz_xrpc_buf __type="u32">102400</sz_xrpc_buf>
+  <ssl __type="bool">0</ssl>
+  <services>http://eamuse.konami.fun/service/services/services/</services>
+</network>
+```
+
+Replace the properties accordingly with the settings provided by your network provider, e.g. the
+URL, further settings like ssl etc.
+
 ## Running
 
 Run `gamestart-XX.bat`, where `XX` corresponds to the version of the game you
@@ -70,6 +137,9 @@ Run the following commands either from a command line (`cmd.exe`) or from
 * Register `regsvr32 D:\MDX\contents\k-clvsd.dll`
 * Register `regsvr32 D:\MDX\contents\xactengine2_10.dll`
 
+The `gamestart-XX.bat` scripts should already take care of this by executing the listed commands
+when launched.
+
 Note: The one that comes with IIDX will hang DDR at startup. The opposite is not true:
 IIDX works just fine with this CLVSD.
 

doc/ddrhook/ddrio-p3io.md

@@ -0,0 +1,27 @@
+# ddrio API implementation with DDR P3IO (Dragon) and EXTIO
+
+This implementation of BT5's ddrio API allows you to use the native DDR P3IO
+of a "Dragon PCB" plus the EXTIO with anything the ddrio API supports.
+
+This is not required to run the actual games supporting the hardware natively.
+However, there are various 3rd party applications using the ddrio API where you
+might benefit from using actual SD cabinet hardware, e.g.
+[vigem-ddrio](../vigem/README.md).
+
+## Setup
+
+For hooks, but likely applicable to 3rd party applications (consolidate their
+manuals).
+
+* Driver: You must have the P3IO driver intalled on your system
+  * Driver from [bemanitools-supplements](https://github.com/djhackersdev/bemanitools-supplement/blob/master/ddr/p3io/README.md)
+* Have `ddrio-p3io.dll` in the same folder as your `ddrhookX.dll`
+* Rename `ddrio-p3io.dll` to `ddrio.dll`
+* Ensure that your `gamestart.bat` actually injects the appropriate ddrhook dll, for example:
+```bat
+inject ddrhook1.dll ddr.exe ...*
+```
+or
+```bat
+launcher -K ddrhook2.dll arkmdxp3.dll ...*
+```

doc/ddrhook/unicorntail.md

@@ -0,0 +1,56 @@
+# Unicorntail
+
+Unicorntail is a hook library to run the DDR games on a hybrid type of hardware referred to as a
+"Chimera" or "Unicorn". Compared to a "Dragon", which refers to the official stock hardware by
+Konami, a Chimera mixes the P3IO board from a PCB used with GF&DM V4-V8, Jubeat, Jubeat Ripples or
+Jubeat Knit with the motherboard from a GF&DM XG, XG2 or XG3 PCB, or a Reflec Beat PCB.
+
+Actual build instructions for such hardware are out of scope here.
+
+## Context
+
+Dragon PCBs are hard to come by compared to finding the parts for a Chimera PCB.
+
+A Chimera PCB however is different in many aspects to the Dragon PCB and requires the use of the
+`unicorntail.dll` hook library.
+
+The Dragon's P3IO has two serial ports that the regular P3IOs do not, and one of these serial ports
+is used to communicate with the card readers. Note that these are actual serial ports driven
+directly by the P3IO microcontroller, these are NOT just passed through to the motherboard like the
+proprietary COM1 and COM2 connectors. 
+
+Unicorn Tail intercepts serial port IO commands being sent to the P3IO and redirects them to a 
+COM4 in Windows instead, where two readers can be connected via the motherboard's RS232 port or 
+a usb RS232 adapter.
+
+## Drivers
+
+You need the P3IO driver installed on your target system. These can be acquired from an actual stock
+HDD or grabbed from
+[bemanitools-supplements](https://dev.s-ul.net/djhackers/bemanitools-supplement/-/blob/master/gfdm/p3io/README.md).
+
+## COM Port Setup
+
+Using Device Manager in Windows, ensure the following COM ports are connected and setup.
+
+COM1: EXTIO
+COM4: Two readers
+
+Windows is often poor about saving the COM port number, so ewf commit (if applicable) and 
+reboot after saving this setting to ensure it sticks.
+
+## Setup and run
+
+Edit the `gamestart.bat` file that you are using and append `unicorntail.dll` to the list of hooks,
+e.g.:
+
+```shell
+launcher.exe -H 33554432 -K unicorntail.dll arkmdxp3.dll %*
+```
+
+If you want to use any ddrhook library in addition, you have to have the hooks in the right order
+to make everything work correctly, e.g.:
+
+```shell
+launcher.exe -H 33554432 -K unicorntail.dll -K ddrhook2.dll arkmdxp3.dll %*
+```

doc/dev/journal/2023-04-03-d01-ezusb-io-boot-security.md

@@ -0,0 +1,289 @@
+# Beatmania IIDX 10th Style - D01 IO boot code and security init
+
+Date: 2023-04-03
+Author: icex2
+
+Documenting decompiled and reverse engineered code snippets from the D01 JAE `bm2dx.exe`. These
+helped me figuring out the two different security boot modes the game supports.
+
+In summary, it supports booting with the C02 IO with a C02 black dongle and a D01 IO board with
+a D01 dongle. No other combination is valid because they didn't make sense back then. You either
+had an upgraded old style/twinkle cabinet to C02 (GEC02) or you bought a new dedicated cabinet
+(GQD01). With 10th style supporting the old C02 dongle, it appears that all owners of a C02 cabinet
+with IO board and C02 dongle received a free software update/HDD. This might make sense considering
+the short life span of C02 and the game being super buggy, especially in earlier/initial revisions.
+
+The game expects the following "configurations" from bemanitools:
+
+* Booting as upgraded C02 with free D01 upgrade
+  * `sec.boot_version=GEC02   `
+  * `sec.boot_seeds=0:0:1`
+  * `sec.black_plug_mcode=GEC02JAA`
+  * "D01 IO pin" on IO board not active
+* Booting as dedicated 
+  * `sec.boot_version=GEC02   `
+  * `sec.boot_seeds=0:1:1`
+  * `sec.black_plug_mcode=GQD01JAA`
+  * "D01 IO pin" on IO board ACTIVE
+
+All the above was derived from reading and understanding the documented code excerpts below.
+
+## io_boot - sub_402700
+
+Called as the first step in the boot statemachine by the "boot" function `sub_40F9C0`.
+
+```c
+// sub_402700
+int __stdcall io_boot(int a1)
+{
+  DWORD (__stdcall *timeGetTime)(); // esi
+  int usb_boot_security_res; // ebp
+  DWORD time_start; // ebx
+  int io_boot_state; // edi
+  DWORD now; // esi
+  BOOL is_d01_boot_mode; // esi
+  BOOL v7; // esi
+  int result; // eax
+  int v9; // [esp+10h] [ebp-2Ch]
+  int firmware_version; // [esp+14h] [ebp-28h]
+  int io_pad_read; // [esp+18h] [ebp-24h] BYREF
+  char v12[32]; // [esp+1Ch] [ebp-20h] BYREF
+
+  dword_4D0768 = 0;
+  strcpy(byte_4D076C, &byte_4D0858);
+  timeGetTime = ::timeGetTime;
+  v9 = 0;
+  usb_boot_security_res = io_pad_read;
+  time_start = ::timeGetTime();
+  io_boot_state = 0;
+  while ( 2 )
+  {
+    switch ( io_boot_state )
+    {
+      case 0:                                   // "start io", firmware download and wait for reconnect
+        if ( usbStart(0) )
+        {
+          if ( time_exceeded(time_start, 20000) )
+            set_io_error_type(1, aErrorUsbioStar);// ERROR(USBIO START)
+        }
+        else
+        {
+          io_boot_state = 1;
+        }
+        goto reset_io_boot_state_label;
+      case 1:                                   // check firmware
+        firmware_version = usbFirmResult();
+        if ( firmware_version == 96 )
+        {
+          if ( time_exceeded(time_start, 25000) )
+            set_io_error_type(1, aErrorFm);     // ERROR(FM), FM = firmware
+        }
+        else
+        {
+          io_boot_state = 2;
+        }
+        goto reset_io_boot_state_label;
+      case 2:
+        if ( !firmware_version )
+        {
+          usbMute(1);
+          time_start = timeGetTime();
+          now = timeGetTime();
+          io_input_is_d01_ezusb = 0;
+          do
+          {
+            usbPadRead(&io_pad_read);
+            if ( (io_pad_read & 0x10) != 0 )
+              io_input_is_d01_ezusb = 1;
+          }
+          while ( !time_exceeded(now, 2000) );
+          io_boot_state = 3;
+reset_io_boot_state_label:
+          timeGetTime = ::timeGetTime;
+          if ( io_boot_state != v9 )
+          {
+            v9 = io_boot_state;
+            time_start = ::timeGetTime();
+          }
+          continue;                             // retry
+        }
+        if ( firmware_version > 128 )
+        {
+          if ( firmware_version == 254 )
+          {
+            set_io_error_type(1, aErrorFmTrnsOut);// ERROR(FM TRNS-OUT)
+            return 1;
+          }
+          if ( firmware_version == 255 )
+          {
+            set_io_error_type(1, aErrorFmTimeOut);// ERROR(FM TIME-OUT)
+            return 1;
+          }
+        }
+        else
+        {
+          switch ( firmware_version )
+          {
+            case 128:
+              set_io_error_type(1, aErrorFmReadErr);// ERROR(FM READ-ERR)
+              return 1;
+            case -113:
+              set_io_error_type(1, aErrorFmDlErr);// ERROR(FM DL-ERR)
+              return 1;
+            case -33:
+              set_io_error_type(1, aErrorFmCmprReq);// ERROR(FM CMPR-REQ)
+              return 1;
+          }
+        }
+UNKNOWN_ERROR_LABEL:
+        set_io_error_type(1, aErrorUnknown);    // ERROR(UNKNOWN)
+        return 1;
+      case 3:
+        if ( io_init_security() )
+        {
+          set_io_error_type(1, aErrorSqInit);   // ERROR(SQ-INIT)
+          return 1;
+        }
+        io_boot_state = 4;
+        goto reset_io_boot_state_label;
+      case 4:
+        is_d01_boot_mode = io_input_is_d01_ezusb != 0;
+        if ( !strncmp(black_dongle_mcode, MCODE_GED01, 5u) )
+          is_d01_boot_mode = 1;
+        usb_boot_security_res = usbBootSecurity(aGec02, 0, is_d01_boot_mode, 1);
+        if ( usb_boot_security_res == 96 )
+        {
+          if ( time_exceeded(time_start, 20000) )
+            set_io_error_type(1, aErrorBtSqInit);// ERROR(BT-SQ-INIT)'
+        }
+        else
+        {
+          io_boot_state = 5;
+        }
+        goto reset_io_boot_state_label;
+      case 5:
+        if ( usb_boot_security_res )
+        {
+          switch ( usb_boot_security_res )
+          {
+            case 0xFFFFFE9F:
+              set_io_error_type(1, aErrorSecurityE);// ERROR(SECURITY EEP)
+              result = 1;
+              break;
+            case 0xFFFFFECF:
+            case 0xFFFFFEDF:
+              set_io_error_type(1, aErrorSecurityI);// ERROR(SECURITY ID or EEP)
+              result = 1;
+              break;
+            case 0xFFFFFEEF:
+              set_io_error_type(1, aErrorSecurityN);// 'ERROR(SECURITY No Match)'
+              result = 1;
+              break;
+            case 0xFFFFFEFF:
+              io_boot_state = 6;
+              goto reset_io_boot_state_label;
+            default:
+              goto UNKNOWN_ERROR_LABEL;
+          }
+        }
+        else
+        {
+          Sleep(0x3E8u);
+          result = 0;
+        }
+        return result;
+      case 6:                                   // security conversion/upgrading security dongles
+        v7 = io_input_is_d01_ezusb != 0;
+        if ( !usbGetSecurityKey(v12) )
+        {
+          if ( usbSetupSecurityComplete(v12, 0, v7, 1) )
+            set_io_error_type(1, aErrorSecurityC);// ERROR(SECURITY CONVERSION FAILED)
+          return 1;
+        }
+        set_io_error_type(1, aErrorSecurityC);  // ERROR(SECURITY CONVERSION FAILED)
+        goto reset_io_boot_state_label;
+      default:
+        goto UNKNOWN_ERROR_LABEL;
+    }
+  }
+}
+```
+
+## io_init_security - sub_402BB0
+
+Sub-function of the [io_boot](#io_boot---sub_402700) function.
+
+```c
+// sub_402BB0
+int io_init_security()
+{
+  int v0; // esi
+  int v2; // esi
+  int mcode_mismatch_cnt; // esi
+  char white_dongle_data_maybe[10]; // [esp+Ch] [ebp-20h] BYREF
+
+  usbSecurityInit();
+  v0 = 0;
+  while ( usbSecurityInitDone() )
+  {
+    if ( v0 > 1200 )
+    {
+      set_io_error_type(-1, aNgSi);
+      return -1;
+    }
+    ++v0;
+    Sleep(16u);
+  }
+  pcbid = 0;
+  dword_4D0754 = 0;
+  word_4D0758 = 0;
+  while ( usbGetPCBID(&pcbid) )
+    Sleep(1u);
+  *(_DWORD *)black_dongle_mcode = 0;
+  v2 = 0;
+  *(_DWORD *)&black_dongle_mcode[4] = 0;
+  while ( usbGetSecurity(black_dongle_mcode) )  // black_dongle_mcode = GQD01JAA
+  {
+    if ( v2 > 1200 )
+    {
+      set_io_error_type(-1, aNgPd);
+      return -1;
+    }
+    ++v2;
+    Sleep(16u);
+  }
+  set_cabinet_type(black_dongle_mcode[6]);
+  mcode_mismatch_cnt = black_dongle_mcode[0] != 'G';
+  if ( io_input_is_d01_ezusb || !strncmp(black_dongle_mcode, MCODE_GED01, 5u) )// Path for using the D01 dongle with D01 IO board
+  {
+    if ( (unsigned __int8)black_dongle_mcode[2] != (char)MCODE_D01 )
+      ++mcode_mismatch_cnt;
+    if ( (unsigned __int8)black_dongle_mcode[3] != SBYTE1(MCODE_D01) )
+      ++mcode_mismatch_cnt;
+    if ( (unsigned __int8)black_dongle_mcode[4] != SBYTE2(MCODE_D01) )
+      ++mcode_mismatch_cnt;
+  }
+  else                                          // Path for using the C02 dongle with C02 IO board
+  {
+    if ( (unsigned __int8)black_dongle_mcode[2] != MCODE_C02[0] )
+      ++mcode_mismatch_cnt;
+    if ( (unsigned __int8)black_dongle_mcode[3] != MCODE_C02[1] )
+      ++mcode_mismatch_cnt;
+    if ( (unsigned __int8)black_dongle_mcode[4] != MCODE_C02[2] )
+      ++mcode_mismatch_cnt;
+    if ( !usbGetSecurityKey(white_dongle_data_maybe) )
+    {
+      black_dongle_mcode[6] = white_dongle_data_maybe[6];
+      set_cabinet_type(white_dongle_data_maybe[6]);
+    }
+  }
+  if ( black_dongle_mcode[5] != 'J' )
+    ++mcode_mismatch_cnt;
+  if ( black_dongle_mcode[6] != 'A' && black_dongle_mcode[6] != 'B' && black_dongle_mcode[6] != 'C' )
+    ++mcode_mismatch_cnt;
+  if ( !mcode_mismatch_cnt )
+    return 0;
+  set_io_error_type(-1, aNgSecurity);
+  return -1;
+}
+```

doc/dev/journal/2023-04-13-iidx-24-gfx-upscaling.md

@@ -0,0 +1,57 @@
+# IIDX 24 GFX upscaling notes
+
+Date: 2023-04-15
+Author: icex2
+
+Notes about my work on fixing the upscaling/downscaling feature of bemanitools for IIDX 20 to 26.
+I realized that the render backend changed significantly that the old method that worked fine
+doesn't work anymore.
+
+The tool used in the screenshots is [apitrace](https://github.com/apitrace/apitrace).
+
+## IIDX 24
+
+The GFX engine in IIDX from 20 to 26 has a changed render loop that includes built-in scaling to
+implement the SD and HD/HD* screen settings that are selectable in the operator menu
+
+### Frame 0 - GFX init part
+
+Setting up the context and device, as well as the frame buffer. This also creates the intermediate
+texture that is configured as the render target once it begins drawing the scene.
+
+![](2023-04-13-iidx-24-gfx-upscaling/init.png)
+
+### Frame 1 - A clean main render path
+
+Start the scene and set the render target to the intermediate texture.
+
+![](2023-04-13-iidx-24-gfx-upscaling/beginscene.png)
+
+After done drawing the scene, the intermediate texture is blended to the framebuffer. With a target
+2D plane having the size of the target resolution, the blending applies linear scaling to either
+up- or downscale the final image.
+
+![](2023-04-13-iidx-24-gfx-upscaling/scaling.png)
+
+## IIDX 10
+
+A recap of the old stuff, see also [my previous notes](2019-10-07-iidx-gfx-rendering-loops.md),
+as I had to look at everything again to properly understand the differences.
+
+### Frame 0 - GFX init part
+
+Setting up the context and device, as well as the frame buffer. Renders directly to the frame
+buffer.
+
+![](2023-04-13-iidx-24-gfx-upscaling/init10.png)
+
+### Frame 1 - A clean main render path
+
+Beginning the scene excerpt. The viewport needs to match the target resolution to display the
+final image correctly.
+
+![](2023-04-13-iidx-24-gfx-upscaling/beginscene10.png)
+
+Ending the scene excerpt, nothing fancy here, just swapping the back buffer.
+
+![](2023-04-13-iidx-24-gfx-upscaling/endscene10.png)

doc/dev/journal/2023-05-28-ddr-p3io-driver-work.md

@@ -0,0 +1,194 @@
+# DDR p3io driver work, various notes
+
+Date: 2023-05-28
+Author: icex2
+
+Notes about my work on writing a DDR P3io driver.
+
+## Python IO board hardware breakout interface
+
+PCB breakout interfaces/connectors on the side of the boards.
+
+### P2IO DDR
+
+Descriptions assume cabinet hardware of an upgraded DDR "black SD cabinet"
+
+* `LINE OUT 1`: Primary audio out to amplifier
+* `LINE OUT 2`: N.C.
+* `RGB`: Video out to monitor, supports 15khz/31khz based on hardware switch for video freq/mode selection
+* `COM1`: Virtual com port that connects to the EXTIO
+* `COM2`: Virtual com port that connects to a pair of ICCA card readers
+* `LAN`: Network connection
+* `PWR`: 100V power in
+* `ANALOG`: N.C.
+* `PORT 1`: Lights output for cabinet lights, e.g. menu button lights, top header lights
+* `PORT 2`: N.C.
+* `DIPSW`
+  * `1`: ???
+  * `2`: On = force all sensor polling mode and allow running the game without an EXTIO
+  * `3`: ???
+  * `4`: On = force 15 khz monitor output
+* `PLUG 1`: Black dongle
+* `PLUG 2`: White dongle
+
+### P3IO GF/DM
+
+Descriptions assume usage of a P3IO from a GF/DM in a "chimera style PCB build" on an upgraded
+DDR "black SD cabinet"
+
+* `PWR`: 100V power in
+* `12V-OUT`: +12V out for external devices
+* `PORT 1`: Lights output for cabinet lights, e.g. menu button lights, top header lights
+* `PORT 2`: N.C.
+* `COM1`: To EXTIO
+* `COM2`: To card readers
+* `RGB`: Video out to monitor, supports 15khz/31khz based on hardware switch for video freq/mode selection
+* `LINE OUT 1`: Primary audio out to amplifier
+* `LINE OUT 2`: N.C.
+* `DIPSW`
+  * `1`:
+  * `2`: 
+  * `3`: 
+  * `4`: On = force 15 khz monitor output
+* `PLUG 1`: Roundplug black dongle
+* `PLUG 2`: Roundplug white dongle
+
+### P3IO DDR(X)
+
+Descriptions assume cabinet hardware of an upgraded DDR "black SD cabinet"
+
+* `PWR`: 100V power in
+* `USB`: USB memory card readers on cabinet
+* `PORT 1`: Lights output for cabinet lights, e.g. menu button lights, top header lights
+* `COM3-4`: Virtual COM ports
+  * COM3 (VCOM1): Pins 1,3,5 on connector -> To card readers
+  * COM4 (VCOM0): Pins 2,4,6 on connector -> N.C.
+* `PLUG`: Breakout to security round plugs (black and white dongles)
+* `COM1`: To EXTIO
+  * Pinout (pins left to right)
+    * 1: TXD1
+    * 2: RXD1
+    * 3: N.C.
+    * 4: N.C.
+    * 5: GND
+* `COM2`: N/A (light spires on black HD cabinet)
+  * Pinout (pins left to right)
+    * 1: TXD2
+    * 2: RXD2
+    * 3: GND
+* `RGB`: Video out to monitor, supports 15khz/31khz based on hardware switch for video freq/mode selection
+* `LINE OUT1`: Primary audio out to amplifier
+* `LINE OUT2`: N.C.
+* `LAN`: Network
+* `DIP SW`
+  * `1`:
+  * `2`: 
+  * `3`: 
+  * `4`: On = force 15 khz monitor output
+
+## Python IO boards and differences
+
+### P3IO DDR(X)
+
+* Connects to USB and actually enumerates as a USB device and not a virtual COM port
+* COM ports 1-4 on breakout of the PCB are being passed through as actual COM ports to the operating system
+
+### P3IO GF/DM
+
+* Connects to USB and actually enumerates as a USB device and not a virtual COM port
+* COM ports 1-2 on breakout of the PCB are just virtual COM ports
+* These do not show up as COM ports on the operating system
+* The game drives the COM ports through the main P3IO protocol with additional P3IO commands
+  to open, read, write and close these virtual COM ports
+
+### P2IO DDR
+
+* Connects to USB and actually enumerates as a USB device and not a virtual COM port
+* COM ports 1-2 on breakout of the PCB are just virtual COM ports
+* These do not show up as COM ports on the operating system
+* The game drives the COM ports through the main P3IO protocol with additional P3IO commands
+  to open, read, write and close these virtual COM ports
+
+
+## Pinout card reader P1 -> P2 mini din8 male to mini din8 male
+
+Port 1 2 and 3: 
+
+* Pin 3: TX
+* Pin 4: GND
+* Pin 5 : RX
+
+Pin 3 and 5 need to be reversed inbetween readers 
+They are all the same, so your cable needs to bridge them over.
+A standard male to male mini din 8 cable does not do that.
+
+### Pinout card reader stock cable s-sub9 to round pin9
+
+```text
+dsub-9 female -> mini-din8 male
+2 (TXD) -> 3
+3 (RXD) -> 5
+5 (GND) -> 4
+```
+
+## ADE board and com port assignments
+
+Default or incorrectly configured?
+
+* `COM1` -> on mainboard
+* `COM2` -> COM2 on P3IO breakout
+* `COM3` -> ???
+* `COM4` -> COM1 on P3IO breakout
+
+## P3IO command init sequence on DDR 18
+
+From the ddrio-python23 library
+
+```text
+.data:1002D5D0 g_init_pakets   db 0AAh, 2, 0, 1, 29h dup(0); field_0.field_0
+.data:1002D5D0                                         ; DATA XREF: initialize_and_send_pakets+5↑o
+.data:1002D5D0                 db 0AAh, 2, 0, 2Fh, 29h dup(0); field_0.field_0
+.data:1002D5D0                 db 0AAh, 3, 1, 27h, 1, 28h dup(0); field_0.field_0
+.data:1002D5D0                 db 0AAh, 2 dup(2), 31h, 29h dup(0); field_0.field_0
+.data:1002D5D0                 db 0AAh, 2, 3, 1, 29h dup(0); field_0.field_0
+.data:1002D5D0                 db 0AAh, 3, 4, 27h, 29h dup(0); field_0.field_0
+.data:1002D5D0                 db 0AAh, 2Bh, 5, 25h, 10h, 28h dup(0); field_0.field_0
+.data:1002D5D0                 db 0AAh, 2Bh, 6, 25h, 10h, 28h dup(0); field_0.field_0
+.data:1002D5D0                 db 0AAh, 2Bh, 7, 25h, 10h, 28h dup(0); field_0.field_0
+.data:1002D5D0                 db 0AAh, 2Bh, 8, 25h, 10h, 28h dup(0); field_0.field_0
+.data:1002D5D0                 db 0AAh, 2Bh, 9, 25h, 10h, 28h dup(0); field_0.field_0
+.data:1002D5D0                 db 0AAh, 2Bh, 0Ah, 25h, 29h dup(0); field_0.field_0
+.data:1002D5D0                 db 0AAh, 2Bh, 0Bh, 25h, 29h dup(0); field_0.field_0
+.data:1002D5D0                 db 0AAh, 2Bh, 0Ch, 25h, 29h dup(0); field_0.field_0
+.data:1002D5D0                 db 0AAh, 2Bh, 0Dh, 25h, 29h dup(0); field_0.field_0
+.data:1002D5D0                 db 0AAh, 2Bh, 0Eh, 25h, 29h dup(0); field_0.field_0
+.data:1002D5D0                 db 0AAh, 3, 0Fh, 5, 29h dup(0); field_0.field_0
+.data:1002D5D0                 db 0AAh, 3, 0, 2Bh, 1, 28h dup(0); field_0.field_0
+.data:1002D5D0                 db 0AAh, 3, 1, 29h, 5, 28h dup(0); field_0.field_0
+.data:1002D5D0                 db 0AAh, 3, 2, 5, 30h, 28h dup(0); field_0.field_0
+.data:1002D5D0                 db 0AAh, 2 dup(3), 27h, 29h dup(0); field_0.field_0
+``
+
+```text
+// 01: get version <- this is part of a "flush" of old data?
+// 2F: set mode
+// 27: get cab type or dispsw
+// 31: get coinstock
+// 1: get version
+// 27: get cab type or dipsw
+// 25: read plug
+// 25: read plug
+// 25: read plug
+// 25: read plug
+// 25: read plug
+// 25: read plug
+// 25: read plug
+// 25: read plug
+// 25: read plug
+// 25: read plug
+// 5: set watchdog
+// 2b: unknown
+// 29: get video freq
+// 5: set watchdog
+// 27: get cab type or dipsw
+```

doc/development.md

@@ -51,6 +51,10 @@ make
 
 All output is located in the *build* folder including the final *bemanitools.zip* package.
 
+Note about using `-j n` option on make: This is currently considered broken/unreliable. Expect to
+run into odd issues like randomly changing unresolved dependency errors. If you attempted this,
+run a `make clean` before running `make` again.
+
 ### Release building
 A release build is a clean build including code formatting and testing. This can be executed by running the following
 command:

doc/iidxhook/README.md

@@ -17,6 +17,7 @@ games:
 * [iidxhook2](iidxhook2.md): DistorteD
 * [iidxhook3](iidxhook3.md): GOLD, DJ TROOPERS, EMPRESS, SIRIUS
 * [iidxhook4](iidxhook4.md): Resort Anthem
+* [iidxhook4-cn](iidxhook4-cn.md): Resort Anthem CN (狂热节拍 IIDX)
 * [iidxhook5](iidxhook5.md): Lincle
 * [iidxhook5-cn](iidxhook5-cn.md): tricoro CN (狂热节拍 IIDX 2) 
 * [iidxhook6](iidxhook6.md): Tricoro

doc/iidxhook/iidxhook3.md

@@ -214,3 +214,12 @@ If one or multiple of these issues apply, use the built in scaling options by se
 to scale to. Usually, you want to set this to the monitor's native resolution, e.g.
 1920x1080 for full HD. You can play around with a few different filters using
 *gfx.scale_back_buffer_filter* which impacts image quality/blurriness on upscaling.
+
+## DJTroopers crashes on boot
+The stock game is buggy and cannot create default backup data correctly. This
+can be fixed by using existing backup data from a stock drive or by using
+the pre-generated backup data for the `e:\` and `f:\` drives provided by
+[bemanitools-supplement](https://github.com/djhackersdev/bemanitools-supplement/tree/master/iidx/15#default-backup-data).
+
+Copy those files to your target location that you have configured to store this
+data, e.g. local `e\` and `f\` folders or the target `e:\` and `f:\` volumes.

doc/iidxhook/iidxhook4-cn.md

@@ -0,0 +1,13 @@
+# Game list
+
+The following games are compatible with this version of iidxhook:
+* Resort Anthem CN (狂热节拍 IIDX)
+
+The games must be bootstrapped using [inject.exe](../inject.md).
+
+# Remarks
+
+Resort Anthem CN (狂热节拍 IIDX):
+
+* Does not have NETWORK function
+* Game doesn't used card readers

doc/iidxhook/iidxhook9.md

@@ -3,6 +3,8 @@
 The following games are compatible with this version of iidxhook:
 * Heroic Verse
 * BISTROVER
+* CASTHOUR
+* RESIDENT
 
 The games must be bootstrapped using [launcher](../launcher.md).
 
@@ -21,17 +23,19 @@ Make sure to have the following dependencies installed:
 
 ## Data setup
 
-We assume that you are using a clean/vanilla data dump. Ensure your ("concents")
+We assume that you are using a clean/vanilla data dump. Ensure your ("contents")
 folder with your unpacked data looks like this:
 - data
 - modules
 - prop
 
-* Copy/Move all files from the *modules* directory to the root folder, so they
+* For versions 27-29, only
-are located next to the *data* and *prop* folders.
+  * Copy/Move all files from the *modules* directory to the root folder, so they
+    are located next to the *data* and *prop* folders.
 * Copy all files from *prop/defaults* to the *prop* folder.
 * Setup proper paths for *dev/nvram* and *dev/raw* in *prop/avs-config.xml* by
 replacing the *<fs>*-block in that file with the following block:
+
 ```
 <fs>
     <root>
@@ -45,9 +49,17 @@ replacing the *<fs>*-block in that file with the following block:
     <nr_filedesc __type="u16">256</nr_filedesc>
 </fs>
 ```
-* Unpack the package containing iidxhook9 into the root folder so iidxhook9.dll
+
-and all other files are located in the same folder as *data*, *prop*, 
+* For versions 27-29, only
-*bm2dx.dll*, etc.
+  * Unpack the package containing iidxhook9 into the root folder so iidxhook9.dll
+    and all other files are located in the same folder as *data*, *prop*, 
+    *bm2dx.dll*, etc.
+* For version 30
+  * Unpack the package containing iidxhook9 into the `modules` folder so iidxhook9.dll
+    and all other files are located in the same folder as the game's DLLs, e.g.
+    *bm2dx.dll*, etc.
+  * Move the `gamestart-30.bat` to the root folder so it is located next to the
+    `modules`, `data` and `prop` folders
 * Run the gamestart-XX.bat file as admin. Where XX matches the version you 
 want to run.
 

doc/popnhook/README.md

@@ -1,6 +1,6 @@
 # popnhook
 
-popnhook is a collection of hook libraries for jubeat providing
+popnhook is a collection of hook libraries for pop'n music providing
 emulation and various patches to run these games on non BemaniPC hardware and
 newer Windows versions.
 

doc/release-process.md

@@ -0,0 +1,29 @@
+# Release process
+
+For bemanitools maintainers, steps for the release process:
+
+1. Update the corresponding section in the [changelog](CHANGELOG.md) with bullet points reflecting
+major features merged into master since the previous release
+1. Make sure you have the latest `master` state pulled to your local copy
+1. Tag the release with the next release number which also be found at the
+[top of the readme](#bemanitools-5) as it always reflects the current version beinged worked on
+on the `master` branch , e.g. 5.35: `git tag 5.35`
+1. Push the tag to upstream: `git push origin 5.35`
+1. The [build pipeline](https://dev.s-ul.net/djhackers/bemanitools/-/pipelines) should start
+automatically once the tag is pushed including the steps `build` and `upload-release`
+1. Once completed successfully, the release is uploaded
+1. Take the changelog of the published version and notify the pigs in the stall about it:
+    1. New post in thread
+        ```
+        <insert version here> released: <direct link to published version>
+
+        Changelog:
+        <paste changelog here>
+        ```
+    1. Update the OP title by bumping the version number in it
+    1. Update the OP post by extending it accordingly (see previous entries)
+
+1. Bump the version number at the [top of this readme](#bemanitools-5) and add a new empty section
+in the [changelog](CHANGELOG.md) with the new version number as title. Commit changes and push to
+`master` branch
+1. Continue developing and merging MRs until you decide its time for another release

doc/tools/README.md

@@ -6,6 +6,7 @@ BT5's supported games, but provides additional features for users and developers
 Various command line tools for quick and easy testing of BT5 API implementations witohut having
 to run any target games.
 
+* [ddriotest](ddriotest.md): `ddrio` API
 * [eamiotest](eamiotest.md): `eamio` API
 * [iidxiotest](iidxiotest.md): `iidxio` API
 * [jbiotest](jbiotest.md): `jbio` API
@@ -15,6 +16,10 @@ to run any target games.
 * [aciotest](aciotest.md): Command line tool for quick and easy testing of ACIO devices without
 having to run a game.
 
+### P3IO DDR testing tool
+* [p3io-ddr-tool](p3io-ddr-tool.md): Extensive command line tool to test and debug a real P3IO DDR
+  (Dragon PCB) IO board + EXTIO
+
 ### Ezusb
 * [ezusb-iidx-fpga-flash](ezusb-iidx-fpga-flash.md): Tool for flashing the FPGA on ezusb 1 boards.
 Required if you want to run games without native ezusb support using BT5's iidxio API.

doc/tools/ddriotest.md

@@ -0,0 +1,3 @@
+Testing tool for development of ddrio libraries used for emulating the main io
+hardware on bemanitools for DanceDanceRevoluion. Just place ddriotest.exe and your 
+custom ddrio.dll in the same folder and run ddriotest.exe.

doc/tools/p3io-ddr-tool.md

@@ -0,0 +1,2 @@
+Test your real DDR P3IO (Dragon) + EXTIO hardware connected to your machine
+using this tool. Just execute it and follow the usage instructions.

src/imports/avs.h

@@ -231,6 +231,7 @@ void property_node_datasize(struct property_node *node);
 bool std_getenv(const char *key, char *val, uint32_t nbytes);
 void std_setenv(const char *key, const char *val);
 
+void* avs_fs_open(const char* path, int mode, int flags);
 int avs_fs_addfs(void *filesys_struct);
 int avs_fs_mount(
     const char *mountpoint, const char *fsroot, const char *fstype, void *data);

src/imports/import_32_1101_avs.def

@@ -18,6 +18,7 @@ EXPORTS
     property_destroy @247 NONAME
     property_insert_read @255 NONAME
     property_node_create @266 NONAME
+    property_node_datasize @267 NONAME
     property_node_refer @278 NONAME
     property_node_remove @279 NONAME
     property_psmap_import @288 NONAME

src/imports/import_32_1304_avs.def

@@ -2,6 +2,7 @@ LIBRARY libavs-win32
 
 EXPORTS
     avs_boot @237 NONAME
+    avs_fs_open @178 NONAME
     avs_net_ctrl @15 NONAME
     avs_shutdown @333 NONAME
     avs_thread_create @183 NONAME
@@ -25,4 +26,4 @@ EXPORTS
     property_read_query_memsize @100 NONAME
     property_search @244 NONAME
     std_getenv @226 NONAME
-    std_setenv  @114 NONAME
+    std_setenv @114 NONAME

src/main/acio/acio.h

@@ -44,6 +44,8 @@ enum ac_io_node_type {
     AC_IO_NODE_TYPE_PANB = 0x090E0000,
     AC_IO_NODE_TYPE_BMPU = 0x0B000000,
     AC_IO_NODE_TYPE_BI2A = 0x0D060000,
+    AC_IO_NODE_TYPE_BIOB = 0x0D050100,
+    AC_IO_NODE_TYPE_BI2B = 0x0D060100,
 };
 
 #pragma pack(push, 1)

src/main/acio/panb.h

@@ -8,8 +8,8 @@
 #define AC_IO_CMD_PANB_START_AUTO_INPUT 0x0115
 
 #define AC_IO_PANB_NUM_NODES 4
-#define AC_IO_PANB_MAX_KEYS (7*AC_IO_PANB_NUM_NODES)
+#define AC_IO_PANB_MAX_KEYS (7 * AC_IO_PANB_NUM_NODES)
-#define AC_IO_PANB_MAX_KEYPAIRS (AC_IO_PANB_MAX_KEYS/2)
+#define AC_IO_PANB_MAX_KEYPAIRS (AC_IO_PANB_MAX_KEYS / 2)
 
 struct ac_io_panb_keypair {
     uint8_t key2 : 4;
@@ -38,5 +38,4 @@ struct ac_io_panb_poll_out {
 };
 #pragma pack(pop)
 
-
 #endif

src/main/aciodrv-proc/panb.c

@@ -5,8 +5,8 @@
 #include "aciodrv/device.h"
 #include "aciodrv/panb.h"
 
-#include "util/thread.h"
 #include "util/log.h"
+#include "util/thread.h"
 
 static int auto_poll_proc(void *auto_poll_param);
 static int auto_poll_threadid;
@@ -17,59 +17,60 @@ static struct ac_io_panb_keypair _keypair[AC_IO_PANB_MAX_KEYPAIRS];
 static CRITICAL_SECTION auto_poll_stop_lock;
 static bool auto_poll_stop;
 
-static int auto_poll_proc(void * param)
+static int auto_poll_proc(void *param)
-{    
+{
-    struct aciodrv_device_ctx * device = (struct aciodrv_device_ctx *) param;
+    struct aciodrv_device_ctx *device = (struct aciodrv_device_ctx *) param;
     struct ac_io_panb_poll_in poll_in;
     bool stop;
-    
+
     do {
         aciodrv_panb_recv_poll(device, &poll_in);
-        
+
         EnterCriticalSection(&keypair_lock);
         memcpy(_keypair, poll_in.keypair, AC_IO_PANB_MAX_KEYPAIRS);
         LeaveCriticalSection(&keypair_lock);
 
         EnterCriticalSection(&auto_poll_stop_lock);
-        stop = auto_poll_stop;      
+        stop = auto_poll_stop;
         LeaveCriticalSection(&auto_poll_stop_lock);
     } while (!stop);
-    
+
     return 0;
 }
 
 bool aciodrv_proc_panb_init(struct aciodrv_device_ctx *device)
 {
     log_assert(device);
-    
+
     if (!aciodrv_panb_start_auto_input(device, 0, AC_IO_PANB_NUM_NODES)) {
         return false;
     }
-    
+
     auto_poll_stop = false;
     InitializeCriticalSection(&keypair_lock);
     InitializeCriticalSection(&auto_poll_stop_lock);
-    auto_poll_threadid = thread_create(auto_poll_proc, (void *)device, 0x4000, 0);
+    auto_poll_threadid =
-    
+        thread_create(auto_poll_proc, (void *) device, 0x4000, 0);
+
     return true;
 }
 
 bool aciodrv_proc_panb_get_state(uint8_t *button_state)
 {
     struct ac_io_panb_keypair keypair[AC_IO_PANB_MAX_KEYPAIRS];
-    
+
     EnterCriticalSection(&keypair_lock);
-    memcpy(keypair, _keypair, AC_IO_PANB_MAX_KEYPAIRS);      
+    memcpy(keypair, _keypair, AC_IO_PANB_MAX_KEYPAIRS);
     LeaveCriticalSection(&keypair_lock);
 
     /* splice the keypairs into separate button values */
-    for (int i=0; i<AC_IO_PANB_MAX_KEYPAIRS; i++) {
+    for (int i = 0; i < AC_IO_PANB_MAX_KEYPAIRS; i++) {
-            uint8_t but1 = keypair[i].key1;
+        uint8_t but1 = keypair[i].key1;
-            uint8_t but2 = keypair[i].key2;
+        uint8_t but2 = keypair[i].key2;
-            button_state[2*i] = but1;
+        button_state[2 * i] = but1;
-            button_state[2*i+1] = but2;
+        button_state[2 * i + 1] = but2;
     }
-     
+
     return true;
 }
 
@@ -78,13 +79,13 @@ void aciodrv_proc_panb_fini(struct aciodrv_device_ctx *device)
     EnterCriticalSection(&auto_poll_stop_lock);
     auto_poll_stop = true;
     LeaveCriticalSection(&auto_poll_stop_lock);
-    
+
     thread_join(auto_poll_threadid, NULL);
     thread_destroy(auto_poll_threadid);
-    
+
     DeleteCriticalSection(&keypair_lock);
     DeleteCriticalSection(&auto_poll_stop_lock);
-    
+
     /* reset is the only way to disable the auto polling on device side */
     aciodrv_device_reset(device);
 }

src/main/aciodrv-proc/panb.h

@@ -4,14 +4,15 @@
 #include "aciodrv/panb.h"
 
 /**
- * Initialize a PANB device. This will take care of setting up the auto-poll and processing
+ * Initialize a PANB device. This will take care of setting up the auto-poll and
- * the poll messages in a separate thread (this is necessary as failing to process messages
+ * processing the poll messages in a separate thread (this is necessary as
- * fast enough will cause the device to malfunction).
+ * failing to process messages fast enough will cause the device to
+ * malfunction).
  *
  * @param device Context of opened device
  * @return True if successful, false on error.
- * @note This function spawns a thread. Caller must call aciodrv_proc_panb_fini to properly 
+ * @note This function spawns a thread. Caller must call aciodrv_proc_panb_fini
- * terminate.
+ * to properly terminate.
  */
 bool aciodrv_proc_panb_init(struct aciodrv_device_ctx *device);
 
@@ -19,13 +20,15 @@ bool aciodrv_proc_panb_init(struct aciodrv_device_ctx *device);
  * Retrieve latest known button state from the PANB device.
  *
  * @param button_state 28 cell array to store button state
- *        (mandatory, upon calling the array contains values between 0 to 15 indicating the keys velocity).
+ *        (mandatory, upon calling the array contains values between 0 to 15
+ * indicating the keys velocity).
  * @return True on success, false on error.
  */
 bool aciodrv_proc_panb_get_state(uint8_t *button_state);
 
 /**
- * Properly terminate the thread and reset the device (this is the only way to stop the auto polling).
+ * Properly terminate the thread and reset the device (this is the only way to
+ * stop the auto polling).
  */
 void aciodrv_proc_panb_fini(struct aciodrv_device_ctx *device);
 

src/main/aciodrv/device.c

@@ -12,7 +12,7 @@
 #include "util/mem.h"
 
 /* Enable to dump all data to the logger */
-//#define AC_IO_MSG_LOG
+// #define AC_IO_MSG_LOG
 
 #define ACIO_MAX_NODES_PER_PORT 16
 
@@ -87,8 +87,11 @@ static bool aciodrv_device_init(struct aciodrv_device_ctx *device)
 }
 
 #ifdef AC_IO_MSG_LOG
-static void
+static void aciodrv_device_log_buffer(
-aciodrv_device_log_buffer(struct aciodrv_device_ctx *device, const char *msg, const uint8_t *buffer, int length)
+    struct aciodrv_device_ctx *device,
+    const char *msg,
+    const uint8_t *buffer,
+    int length)
 {
     char str[4096];
 
@@ -97,7 +100,8 @@ aciodrv_device_log_buffer(struct aciodrv_device_ctx *device, const char *msg, co
 }
 #endif
 
-static bool aciodrv_device_send(struct aciodrv_device_ctx *device, const uint8_t *buffer, int length)
+static bool aciodrv_device_send(
+    struct aciodrv_device_ctx *device, const uint8_t *buffer, int length)
 {
     uint8_t send_buf[512];
     int send_buf_pos = 0;
@@ -138,15 +142,20 @@ static bool aciodrv_device_send(struct aciodrv_device_ctx *device, const uint8_t
     aciodrv_device_log_buffer(device, "Send (2)", send_buf, send_buf_pos);
 #endif
 
-    if (aciodrv_port_write(device->fd, send_buf, send_buf_pos) != send_buf_pos) {
+    if (aciodrv_port_write(device->fd, send_buf, send_buf_pos) !=
-        log_warning("[%p] Sending data with length %d failed", device->fd, send_buf_pos);
+        send_buf_pos) {
+        log_warning(
+            "[%p] Sending data with length %d failed",
+            device->fd,
+            send_buf_pos);
         return false;
     }
 
     return true;
 }
 
-static int aciodrv_device_receive(struct aciodrv_device_ctx *device, uint8_t *buffer, int max_resp_size)
+static int aciodrv_device_receive(
+    struct aciodrv_device_ctx *device, uint8_t *buffer, int max_resp_size)
 {
     uint8_t recv_buf[512];
     int recv_size = 0;
@@ -161,7 +170,6 @@ static int aciodrv_device_receive(struct aciodrv_device_ctx *device, uint8_t *bu
         read = aciodrv_port_read(device->fd, recv_buf, 1);
     } while (recv_buf[0] == AC_IO_SOF);
 
-
     if (read > 0) {
         /* recv_buf[0] is already the first byte of the message.
            now read until nothing's left */
@@ -189,8 +197,8 @@ static int aciodrv_device_receive(struct aciodrv_device_ctx *device, uint8_t *bu
                 /* next byte is our real data
                    overwrite escape byte */
                 do {
-                    read = aciodrv_port_read(
+                    read =
-                        device->fd, recv_buf + recv_size, 1);
+                        aciodrv_port_read(device->fd, recv_buf + recv_size, 1);
                 } while (read == 0);
 
                 if (read < 0) {
@@ -204,7 +212,8 @@ static int aciodrv_device_receive(struct aciodrv_device_ctx *device, uint8_t *bu
 
             if (recv_size > offsetof(struct ac_io_message, cmd.nbytes)) {
                 // header + data + checksum
-                expected_size = offsetof(struct ac_io_message, cmd.raw) + ((struct ac_io_message*)recv_buf)->cmd.nbytes + 1;
+                expected_size = offsetof(struct ac_io_message, cmd.raw) +
+                    ((struct ac_io_message *) recv_buf)->cmd.nbytes + 1;
             }
         }
 
@@ -215,7 +224,11 @@ static int aciodrv_device_receive(struct aciodrv_device_ctx *device, uint8_t *bu
 
         /* recv_size - 1: omit checksum for checksum calc */
         if ((recv_size - 1) > max_resp_size) {
-            log_warning("[%p] Expected %d got %d", device->fd, max_resp_size - 6, recv_buf[4]);
+            log_warning(
+                "[%p] Expected %d got %d",
+                device->fd,
+                max_resp_size - 6,
+                recv_buf[4]);
             return -1;
         }
         for (int i = 0; i < recv_size - 1; i++) {
@@ -254,9 +267,7 @@ static uint8_t aciodrv_device_enum_nodes(struct aciodrv_device_ctx *device)
     msg.cmd.count = 0;
 
     if (!aciodrv_send_and_recv(
-            device,
+            device, &msg, offsetof(struct ac_io_message, cmd.raw) + 1)) {
-            &msg,
-            offsetof(struct ac_io_message, cmd.raw) + 1)) {
         log_warning("Enumerating nodes failed");
         return 0;
     }
@@ -266,7 +277,10 @@ static uint8_t aciodrv_device_enum_nodes(struct aciodrv_device_ctx *device)
     return msg.cmd.count;
 }
 
-static bool aciodrv_device_get_version(struct aciodrv_device_ctx *device, uint8_t node_id, struct aciodrv_device_node_version *version)
+static bool aciodrv_device_get_version(
+    struct aciodrv_device_ctx *device,
+    uint8_t node_id,
+    struct aciodrv_device_node_version *version)
 {
     struct ac_io_message msg;
 
@@ -299,7 +313,10 @@ static bool aciodrv_device_get_version(struct aciodrv_device_ctx *device, uint8_
         msg.cmd.version.date,
         msg.cmd.version.time);
 
-    memcpy(version->product, msg.cmd.version.product_code, ACIO_NODE_PRODUCT_CODE_LEN);
+    memcpy(
+        version->product,
+        msg.cmd.version.product_code,
+        ACIO_NODE_PRODUCT_CODE_LEN);
     version->type = ac_io_u32(msg.cmd.version.type);
     version->major = msg.cmd.version.major;
     version->minor = msg.cmd.version.minor;
@@ -308,7 +325,8 @@ static bool aciodrv_device_get_version(struct aciodrv_device_ctx *device, uint8_
     return true;
 }
 
-static bool aciodrv_device_start_node(struct aciodrv_device_ctx *device, uint8_t node_id)
+static bool
+aciodrv_device_start_node(struct aciodrv_device_ctx *device, uint8_t node_id)
 {
     struct ac_io_message msg;
 
@@ -317,9 +335,7 @@ static bool aciodrv_device_start_node(struct aciodrv_device_ctx *device, uint8_t
     msg.cmd.nbytes = 0;
 
     if (!aciodrv_send_and_recv(
-            device,
+            device, &msg, offsetof(struct ac_io_message, cmd.raw) + 1)) {
-            &msg,
-            offsetof(struct ac_io_message, cmd.raw) + 1)) {
         log_warning("Starting node %d failed", node_id);
         return false;
     }
@@ -334,7 +350,8 @@ struct aciodrv_device_ctx *aciodrv_device_open(const char *port_path, int baud)
     return aciodrv_device_open_path(port_path, baud);
 }
 
-struct aciodrv_device_ctx *aciodrv_device_open_path(const char *port_path, int baud)
+struct aciodrv_device_ctx *
+aciodrv_device_open_path(const char *port_path, int baud)
 {
     HANDLE port = aciodrv_port_open(port_path, baud);
 
@@ -342,7 +359,8 @@ struct aciodrv_device_ctx *aciodrv_device_open_path(const char *port_path, int b
         return NULL;
     }
 
-    struct aciodrv_device_ctx *device = xmalloc(sizeof(struct aciodrv_device_ctx));
+    struct aciodrv_device_ctx *device =
+        xmalloc(sizeof(struct aciodrv_device_ctx));
 
     memset(device, 0, sizeof(struct aciodrv_device_ctx));
     device->fd = port;
@@ -384,16 +402,23 @@ uint8_t aciodrv_device_get_node_count(struct aciodrv_device_ctx *device)
     return device->node_count;
 }
 
-bool aciodrv_device_get_node_product_ident(struct aciodrv_device_ctx *device, uint8_t node_id, char product[ACIO_NODE_PRODUCT_CODE_LEN])
+bool aciodrv_device_get_node_product_ident(
+    struct aciodrv_device_ctx *device,
+    uint8_t node_id,
+    char product[ACIO_NODE_PRODUCT_CODE_LEN])
 {
     if (device->node_count == 0 || node_id > device->node_count) {
         return false;
     }
 
-    memcpy(product, device->node_versions[node_id].product, ACIO_NODE_PRODUCT_CODE_LEN);
+    memcpy(
+        product,
+        device->node_versions[node_id].product,
+        ACIO_NODE_PRODUCT_CODE_LEN);
     return true;
 }
-uint32_t aciodrv_device_get_node_product_type(struct aciodrv_device_ctx *device, uint8_t node_id)
+uint32_t aciodrv_device_get_node_product_type(
+    struct aciodrv_device_ctx *device, uint8_t node_id)
 {
     if (device->node_count == 0 || node_id > device->node_count) {
         return 0;
@@ -402,7 +427,9 @@ uint32_t aciodrv_device_get_node_product_type(struct aciodrv_device_ctx *device,
     return device->node_versions[node_id].type;
 }
 
-const struct aciodrv_device_node_version *aciodrv_device_get_node_product_version(struct aciodrv_device_ctx *device, uint8_t node_id)
+const struct aciodrv_device_node_version *
+aciodrv_device_get_node_product_version(
+    struct aciodrv_device_ctx *device, uint8_t node_id)
 {
     if (device->node_count == 0 || node_id > device->node_count) {
         return NULL;
@@ -430,7 +457,10 @@ bool aciodrv_send(struct aciodrv_device_ctx *device, struct ac_io_message *msg)
     return true;
 }
 
-bool aciodrv_recv(struct aciodrv_device_ctx *device, struct ac_io_message *msg, int max_resp_size)
+bool aciodrv_recv(
+    struct aciodrv_device_ctx *device,
+    struct ac_io_message *msg,
+    int max_resp_size)
 {
 #ifdef AC_IO_MSG_LOG
     log_info("[%p] Beginning recv: (%d b)", device->fd, max_resp_size);
@@ -441,7 +471,10 @@ bool aciodrv_recv(struct aciodrv_device_ctx *device, struct ac_io_message *msg,
     return true;
 }
 
-bool aciodrv_send_and_recv(struct aciodrv_device_ctx *device, struct ac_io_message *msg, int max_resp_size)
+bool aciodrv_send_and_recv(
+    struct aciodrv_device_ctx *device,
+    struct ac_io_message *msg,
+    int max_resp_size)
 {
     if (!aciodrv_send(device, msg)) {
         return false;

src/main/aciodrv/device.h

@@ -28,11 +28,13 @@ struct aciodrv_device_node_version {
  */
 struct aciodrv_device_ctx *aciodrv_device_open(const char *port_path, int baud)
 #ifdef __GNUC__
-__attribute__((deprecated("Use aciomgr instead if device is shareable, else aciodrv_device_open_path")))
+    __attribute__((deprecated("Use aciomgr instead if device is shareable, "
+                              "else aciodrv_device_open_path")))
 #endif
-;
+    ;
 
-struct aciodrv_device_ctx *aciodrv_device_open_path(const char *port_path, int baud);
+struct aciodrv_device_ctx *
+aciodrv_device_open_path(const char *port_path, int baud);
 
 /**
  * Get the node count on the opened device.
@@ -51,7 +53,10 @@ uint8_t aciodrv_device_get_node_count(struct aciodrv_device_ctx *device);
  * @return True on success, false on error. If True the variable product
  * contains the identifier of the queried node.
  */
-bool aciodrv_device_get_node_product_ident(struct aciodrv_device_ctx *device, uint8_t node_id, char product[ACIO_NODE_PRODUCT_CODE_LEN]);
+bool aciodrv_device_get_node_product_ident(
+    struct aciodrv_device_ctx *device,
+    uint8_t node_id,
+    char product[ACIO_NODE_PRODUCT_CODE_LEN]);
 
 /**
  * Get the product identifier of an enumerated node.
@@ -60,7 +65,8 @@ bool aciodrv_device_get_node_product_ident(struct aciodrv_device_ctx *device, ui
  * @param node_id Id of the node. Needs to be in range of the total node count.
  * @return product type ID on success, or 0 on failure
  */
-uint32_t aciodrv_device_get_node_product_type(struct aciodrv_device_ctx *device, uint8_t node_id);
+uint32_t aciodrv_device_get_node_product_type(
+    struct aciodrv_device_ctx *device, uint8_t node_id);
 
 /**
  * Get the product version of an enumerated node.
@@ -69,7 +75,9 @@ uint32_t aciodrv_device_get_node_product_type(struct aciodrv_device_ctx *device,
  * @param node_id Id of the node. Needs to be in range of the total node count.
  * @return Pointer to the version struct
  */
-const struct aciodrv_device_node_version *aciodrv_device_get_node_product_version(struct aciodrv_device_ctx *device, uint8_t node_id);
+const struct aciodrv_device_node_version *
+aciodrv_device_get_node_product_version(
+    struct aciodrv_device_ctx *device, uint8_t node_id);
 
 /**
  * Send a message to the ACIO bus and receive an answer.
@@ -82,7 +90,10 @@ const struct aciodrv_device_node_version *aciodrv_device_get_node_product_versio
  * @param resp_size Size of the expecting response.
  * @return True on success, false on error.
  */
-bool aciodrv_send_and_recv(struct aciodrv_device_ctx *device, struct ac_io_message *msg, int max_resp_size);
+bool aciodrv_send_and_recv(
+    struct aciodrv_device_ctx *device,
+    struct ac_io_message *msg,
+    int max_resp_size);
 
 /**
  * Send a message to the ACIO bus.
@@ -90,7 +101,8 @@ bool aciodrv_send_and_recv(struct aciodrv_device_ctx *device, struct ac_io_messa
  * @param device Context of opened device
  * @param msg Msg to send to the bus.
  * @return True on success, false on error.
- * @note Prefer the use of aciodrv_send_and_recv when possible. This is for commands which don't trigger a reply.
+ * @note Prefer the use of aciodrv_send_and_recv when possible. This is for
+ * commands which don't trigger a reply.
  */
 bool aciodrv_send(struct aciodrv_device_ctx *device, struct ac_io_message *msg);
 
@@ -101,9 +113,13 @@ bool aciodrv_send(struct aciodrv_device_ctx *device, struct ac_io_message *msg);
  * @param msg Msg to send to the bus. Make sure that the buffer
  *        is big enough to receive the response.
  * @return True on success, false on error.
- * @note Prefer the use of aciodrv_send_and_recv when possible. This is for unsollicited incoming messages.
+ * @note Prefer the use of aciodrv_send_and_recv when possible. This is for
+ * unsollicited incoming messages.
  */
-bool aciodrv_recv(struct aciodrv_device_ctx *device, struct ac_io_message *msg, int max_resp_size);
+bool aciodrv_recv(
+    struct aciodrv_device_ctx *device,
+    struct ac_io_message *msg,
+    int max_resp_size);
 
 /**
  * Reset an opened device.
@@ -115,7 +131,7 @@ bool aciodrv_device_reset(struct aciodrv_device_ctx *device);
 
 /**
  * Close the previously opened ACIO device.
- * 
+ *
  * @param device Context of opened device
  */
 void aciodrv_device_close(struct aciodrv_device_ctx *device);

src/main/aciodrv/h44b.c

@@ -9,9 +9,7 @@
 
 #include "util/log.h"
 
-bool aciodrv_h44b_init(
+bool aciodrv_h44b_init(struct aciodrv_device_ctx *device, uint8_t node_id)
-    struct aciodrv_device_ctx *device,
-    uint8_t node_id)
 {
     // unlike input devices like KFCA, H44B has no watchdog or special init code
     // requirements - shared ACIO node initialisation is enough
@@ -34,9 +32,7 @@ bool aciodrv_h44b_lights(
     msg.cmd.h44b_output = *lights;
 
     if (!aciodrv_send_and_recv(
-            device,
+            device, &msg, offsetof(struct ac_io_message, cmd.raw) + 1)) {
-            &msg,
-            offsetof(struct ac_io_message, cmd.raw) + 1)) {
         log_warning("Polling of node %d failed", node_id + 1);
         return false;
     }

src/main/aciodrv/h44b.h

@@ -1,8 +1,8 @@
 #ifndef ACIODRV_H44B_H
 #define ACIODRV_H44B_H
 
-#include "aciodrv/device.h"
 #include "acio/h44b.h"
+#include "aciodrv/device.h"
 
 /**
  * Initialize an H44B node.

src/main/aciodrv/icca.c

@@ -8,8 +8,7 @@
 #include "util/log.h"
 
 static bool aciodrv_icca_queue_loop_start(
-    struct aciodrv_device_ctx *device,
+    struct aciodrv_device_ctx *device, uint8_t node_id)
-    uint8_t node_id)
 {
     struct ac_io_message msg;
 
@@ -21,9 +20,7 @@ static bool aciodrv_icca_queue_loop_start(
     msg.cmd.status = 0;
 
     if (!aciodrv_send_and_recv(
-            device,
+            device, &msg, offsetof(struct ac_io_message, cmd.raw) + 1)) {
-            &msg,
-            offsetof(struct ac_io_message, cmd.raw) + 1)) {
         log_warning("Starting queue loop failed");
         return false;
     }
@@ -137,16 +134,14 @@ bool aciodrv_icca_read_card(
     return true;
 }
 
-bool aciodrv_icca_is_slotted(
+bool aciodrv_icca_is_slotted(struct aciodrv_device_ctx *device, uint8_t node_id)
-    struct aciodrv_device_ctx *device,
-    uint8_t node_id)
 {
     const struct aciodrv_device_node_version *version;
     version = aciodrv_device_get_node_product_version(device, node_id);
 
     // current heuristic is to check if version >= 1.5
     if (version) {
-        if (version->major == 1)  {
+        if (version->major == 1) {
             if (version->minor >= 5) {
                 return false;
             }
@@ -157,8 +152,7 @@ bool aciodrv_icca_is_slotted(
 }
 
 bool aciodrv_icca_poll_felica(
-    struct aciodrv_device_ctx *device,
+    struct aciodrv_device_ctx *device, uint8_t node_id)
-    uint8_t node_id)
 {
     struct ac_io_message msg;
 

src/main/aciodrv/icca.h

@@ -74,9 +74,9 @@ bool aciodrv_icca_read_card(
 /**
  * Uses some heruistics based on the product ident to determine if the detected
  * device is a slotted (true) or wavepass reader (false).
- * 
+ *
  * This function will also return false if the provided node_id is invalid.
- * 
+ *
  * @param device Context of opened device
  * @param node_id Id of the node to query (0 based).
  * @return True on slotted, false on wavepass.
@@ -85,18 +85,17 @@ bool aciodrv_icca_read_card(
  * @see driver.h
  */
 bool aciodrv_icca_is_slotted(
-    struct aciodrv_device_ctx *device,
+    struct aciodrv_device_ctx *device, uint8_t node_id);
-    uint8_t node_id);
 
 /**
  * Polls the felica chip on wavepass readers. This will cause the state of the
  * reader to be AC_IO_ICCA_STATUS_BUSY_NEW for a few polls, before returning
  * either: AC_IO_ICCA_STATUS_IDLE_NEW or AC_IO_ICCA_STATUS_GOT_UID.
- * 
+ *
  * The user should take care to call this every so often to actually get new
  * felica UIDs, instead of just old NFC idents. The game seems to do it every
  * 5 or so polls after the last AC_IO_ICCA_STATUS_BUSY_NEW poll.
- * 
+ *
  * @param device Context of opened device
  * @param node_id Id of the node to query (0 based).
  * @return True on success, false on error.
@@ -105,7 +104,6 @@ bool aciodrv_icca_is_slotted(
  * @see driver.h
  */
 bool aciodrv_icca_poll_felica(
-    struct aciodrv_device_ctx *device,
+    struct aciodrv_device_ctx *device, uint8_t node_id);
-    uint8_t node_id);
 
 #endif

src/main/aciodrv/kfca.c

@@ -7,9 +7,8 @@
 
 #include "util/log.h"
 
-static bool aciodrv_kfca_watchdog_start(
+static bool
-    struct aciodrv_device_ctx *device,
+aciodrv_kfca_watchdog_start(struct aciodrv_device_ctx *device, uint8_t node_id)
-    uint8_t node_id)
 {
     struct ac_io_message msg;
 
@@ -25,11 +24,15 @@ static bool aciodrv_kfca_watchdog_start(
 
     if (!aciodrv_send_and_recv(
             device, &msg, offsetof(struct ac_io_message, cmd.raw) + 2)) {
-        log_warning("Starting watchdog failed"); return false;
+        log_warning("Starting watchdog failed");
+        return false;
     }
 
-    log_warning("Started watchdog of node %d, sz: %d, status: %d",
+    log_warning(
-        node_id, msg.cmd.nbytes, msg.cmd.status);
+        "Started watchdog of node %d, sz: %d, status: %d",
+        node_id,
+        msg.cmd.nbytes,
+        msg.cmd.status);
 
     return true;
 }
@@ -56,9 +59,7 @@ bool aciodrv_kfca_amp(
     msg.cmd.raw[3] = subwoofer;
 
     if (!aciodrv_send_and_recv(
-            device,
+            device, &msg, offsetof(struct ac_io_message, cmd.raw) + 1)) {
-            &msg,
-            offsetof(struct ac_io_message, cmd.raw) + 1)) {
         log_warning("Setting AMP failed");
         return false;
     }
@@ -68,9 +69,7 @@ bool aciodrv_kfca_amp(
     return true;
 }
 
-bool aciodrv_kfca_init(
+bool aciodrv_kfca_init(struct aciodrv_device_ctx *device, uint8_t node_id)
-    struct aciodrv_device_ctx *device,
-    uint8_t node_id)
 {
     log_assert(device);
 

src/main/aciodrv/kfca.h

@@ -2,6 +2,7 @@
 #define ACIODRV_KFCA_H
 
 #include "acio/kfca.h"
+#include "aciodrv/device.h"
 
 /**
  * Initialize an KFCA node.

src/main/aciodrv/panb.c

@@ -5,10 +5,11 @@
 #include "aciodrv/device.h"
 #include "aciodrv/panb.h"
 
-#include "util/thread.h"
 #include "util/log.h"
+#include "util/thread.h"
 
-bool aciodrv_panb_start_auto_input(struct aciodrv_device_ctx *device, uint8_t node_id, uint8_t node_count)
+bool aciodrv_panb_start_auto_input(
+    struct aciodrv_device_ctx *device, uint8_t node_id, uint8_t node_count)
 {
     log_assert(device);
     struct ac_io_message msg;
@@ -33,34 +34,40 @@ bool aciodrv_panb_start_auto_input(struct aciodrv_device_ctx *device, uint8_t no
     return true;
 }
 
-bool aciodrv_panb_recv_poll(struct aciodrv_device_ctx *device, struct ac_io_panb_poll_in *poll_in)
+bool aciodrv_panb_recv_poll(
+    struct aciodrv_device_ctx *device, struct ac_io_panb_poll_in *poll_in)
 {
     log_assert(device);
     struct ac_io_message msg;
-    struct ac_io_panb_poll_in *poll_res = (struct ac_io_panb_poll_in *) &msg.cmd.raw;
+    struct ac_io_panb_poll_in *poll_res =
-    
+        (struct ac_io_panb_poll_in *) &msg.cmd.raw;
+
     msg.cmd.code = ac_io_u16(AC_IO_CMD_PANB_POLL_REPLY);
     msg.cmd.nbytes = sizeof(struct ac_io_panb_poll_in);
 
-    if (!aciodrv_recv(device, 
+    if (!aciodrv_recv(
-            &msg, offsetof(struct ac_io_message, cmd.raw) + msg.cmd.nbytes + 1)) {
+            device,
+            &msg,
+            offsetof(struct ac_io_message, cmd.raw) + msg.cmd.nbytes + 1)) {
         log_warning("Getting state failed");
         return false;
     }
-    
+
-    if (poll_in != NULL){
+    if (poll_in != NULL) {
         memcpy(poll_in, poll_res, sizeof(struct ac_io_panb_poll_in));
     }
-    
+
     return true;
 }
 
-bool aciodrv_panb_send_lamp(struct aciodrv_device_ctx *device,
+bool aciodrv_panb_send_lamp(
-    uint8_t node_id, struct ac_io_panb_poll_out *state)
+    struct aciodrv_device_ctx *device,
+    uint8_t node_id,
+    struct ac_io_panb_poll_out *state)
 {
     log_assert(device);
     struct ac_io_message msg;
-    
+
     /* only the first node is handling the commands */
     if (node_id != 0) {
         return true;

src/main/aciodrv/panb.h

@@ -11,39 +11,43 @@
  * @param node_count The number of nodes to poll.
  * @return True if successful, false on error.
  * @note node_id should be 0, PANB internally manages the other nodes.
- * @note Upon calling, the device will stop replying to commands and just keep sending
+ * @note Upon calling, the device will stop replying to commands and just keep
- * AC_IO_CMD_PANB_POLL_REPLY messages indefinitely. Failure to retrieve them fast enough
+ * sending AC_IO_CMD_PANB_POLL_REPLY messages indefinitely. Failure to retrieve
- * will cause the device to malfunction. It is thus advised to make use of the aciodrv-proc
+ * them fast enough will cause the device to malfunction. It is thus advised to
- * module to spawn a thread that will handle these messages and provide an easy access to the
+ * make use of the aciodrv-proc module to spawn a thread that will handle these
- * latest input state.
- * @note This module is supposed to be used in combination with the common
- *       device driver foundation.
- * @see driver.h
- */
-bool aciodrv_panb_start_auto_input(struct aciodrv_device_ctx *device, uint8_t node_id, uint8_t node_count);
-
-/**
- * Retrieve a AC_IO_CMD_PANB_POLL_REPLY message from a PANB device. This assumes that there
- * is such message incoming (ie. that start_auto_input has been called prior).
- *
- * @param device Context of opened device.
- * @param poll_in Buffer to hold the received message, or NULL.
- * @return True if successful, false on error.
- * @note node_id should be 0, PANB internally manages the other nodes.
- * @note Failure to retrieve the incoming messages fast enough will cause the device to malfunction. 
- * It is thus advised to make use of the aciodrv-proc module to spawn a thread that will handle these 
  * messages and provide an easy access to the latest input state.
  * @note This module is supposed to be used in combination with the common
  *       device driver foundation.
  * @see driver.h
  */
-bool aciodrv_panb_recv_poll(struct aciodrv_device_ctx *device, struct ac_io_panb_poll_in *poll_in);
+bool aciodrv_panb_start_auto_input(
+    struct aciodrv_device_ctx *device, uint8_t node_id, uint8_t node_count);
+
+/**
+ * Retrieve a AC_IO_CMD_PANB_POLL_REPLY message from a PANB device. This assumes
+ * that there is such message incoming (ie. that start_auto_input has been
+ * called prior).
+ *
+ * @param device Context of opened device.
+ * @param poll_in Buffer to hold the received message, or NULL.
+ * @return True if successful, false on error.
+ * @note node_id should be 0, PANB internally manages the other nodes.
+ * @note Failure to retrieve the incoming messages fast enough will cause the
+ * device to malfunction. It is thus advised to make use of the aciodrv-proc
+ * module to spawn a thread that will handle these messages and provide an easy
+ * access to the latest input state.
+ * @note This module is supposed to be used in combination with the common
+ *       device driver foundation.
+ * @see driver.h
+ */
+bool aciodrv_panb_recv_poll(
+    struct aciodrv_device_ctx *device, struct ac_io_panb_poll_in *poll_in);
 
 /**
  * Light lamps on a PANB device.
  *
  * @param node_id Id of the node to query (0 based).
- * @param state Pointer to a lamp state struct 
+ * @param state Pointer to a lamp state struct
  *        (mandatory).
  * @return True on success, false on error.
  * @note node_id should be 0, PANB internally manages the other nodes.
@@ -51,6 +55,9 @@ bool aciodrv_panb_recv_poll(struct aciodrv_device_ctx *device, struct ac_io_panb
  *       device driver foundation.
  * @see driver.h
  */
-bool aciodrv_panb_send_lamp(struct aciodrv_device_ctx *device, uint8_t node_id, struct ac_io_panb_poll_out *state);
+bool aciodrv_panb_send_lamp(
+    struct aciodrv_device_ctx *device,
+    uint8_t node_id,
+    struct ac_io_panb_poll_out *state);
 
 #endif

src/main/aciodrv/port.c

@@ -148,7 +148,8 @@ int aciodrv_port_write(HANDLE port_fd, const void *bytes, int nbytes)
     }
 
     if (!WriteFile(port_fd, bytes, nbytes, &nwrit, NULL)) {
-        log_warning("[%p] WriteFile failed: err = %lu", port_fd, GetLastError());
+        log_warning(
+            "[%p] WriteFile failed: err = %lu", port_fd, GetLastError());
 
         return -1;
     }

src/main/aciodrv/port.h

@@ -40,7 +40,7 @@ int aciodrv_port_write(HANDLE port_fd, const void *bytes, int nbytes);
 
 /**
  * Close the previously opened com port.
- * 
+ *
  * @param port_fd HANDLE of opened serial port
  */
 void aciodrv_port_close(HANDLE port_fd);

src/main/aciodrv/rvol.c

@@ -8,9 +8,7 @@
 #include "util/log.h"
 
 static bool aciodrv_rvol_change_expand_mode(
-    struct aciodrv_device_ctx *device,
+    struct aciodrv_device_ctx *device, uint8_t node_id, uint8_t mode)
-    uint8_t node_id,
-    uint8_t mode)
 {
     struct ac_io_message msg;
 
@@ -28,15 +26,12 @@ static bool aciodrv_rvol_change_expand_mode(
         return false;
     }
 
-    log_info("I/O expand mode set %d, mode: %d",
+    log_info("I/O expand mode set %d, mode: %d", node_id, mode);
-        node_id, mode);
 
     return true;
 }
 
-bool aciodrv_rvol_init(
+bool aciodrv_rvol_init(struct aciodrv_device_ctx *device, uint8_t node_id)
-    struct aciodrv_device_ctx *device,
-    uint8_t node_id)
 {
     log_assert(device);
 

src/main/acioemu/icca.c

@@ -147,7 +147,7 @@ void ac_io_emu_icca_dispatch_request(
             break;
 
         case AC_IO_ICCA_CMD_SET_SLOT_STATE: {
-            if(icca->version == v150) {
+            if (icca->version == v150) {
                 ac_io_emu_icca_send_state(icca, req, 0, false);
             } else {
                 struct ac_io_icca_misc *misc =
@@ -267,8 +267,7 @@ static void ac_io_emu_icca_cmd_send_version(
     } else {
         // probably log invalid version here
         log_warning(
-            "Unknown ICCA version: %d emulation requested",
+            "Unknown ICCA version: %d emulation requested", icca->version);
-            icca->version);
     }
 
     resp.cmd.version.revision = 0x00;
@@ -487,7 +486,7 @@ ac_io_emu_icca_cipher(struct ac_io_emu_icca *icca, uint8_t *data, size_t length)
 
         // process data
         data[i] =
-            (uint8_t)(icca->cipher_keys[0] >> (((3 - count4) << 3)) ^ data[i]);
+            (uint8_t) (icca->cipher_keys[0] >> (((3 - count4) << 3)) ^ data[i]);
     }
 }
 
@@ -512,7 +511,7 @@ static void ac_io_emu_icca_cipher_set_key(
     resp.cmd.raw[0] = (reader_key >> 24) & 0xFF;
     resp.cmd.raw[1] = (reader_key >> 16) & 0xFF;
     resp.cmd.raw[2] = (reader_key >> 8) & 0xFF;
-    resp.cmd.raw[3] = (reader_key) & 0xFF;
+    resp.cmd.raw[3] = (reader_key) &0xFF;
 
     // so I looked these constants up, this isn't actually a secure key
     // generator it's actually Marsaglia's "KISS" algorithm with different

src/main/aciomgr/manager.c

@@ -105,7 +105,6 @@ struct aciomgr_port_dispatcher *aciomgr_port_init(const char *path, int baud)
         return NULL;
     }
 
-
     struct aciomgr_port_dispatcher *entry;
 
     EnterCriticalSection(&mgr_cs);

src/main/aciotest/bi2a-sdvx.c

@@ -29,7 +29,6 @@ bool aciotest_bi2a_sdvx_handler_update(
         return false;
     }
 
-    
     pin.raw[0] = ac_io_u16(pin.raw[0]);
     pin.raw[1] = ac_io_u16(pin.raw[1]);
 

src/main/aciotest/icca.c

@@ -5,7 +5,6 @@
 
 #include "aciodrv/icca.h"
 
-
 #define IDLE_RESPONSES_BETWEEN_FELICA_POLLS 5
 
 struct icca_handler_ctx {
@@ -19,7 +18,7 @@ bool aciotest_icca_handler_init(
 {
     *ctx = malloc(sizeof(struct icca_handler_ctx));
 
-    struct icca_handler_ctx *icca_ctx = (struct icca_handler_ctx*)*ctx;
+    struct icca_handler_ctx *icca_ctx = (struct icca_handler_ctx *) *ctx;
     icca_ctx->init = false;
 
     icca_ctx->slotted_reader = true;
@@ -34,7 +33,7 @@ bool aciotest_icca_handler_init(
 bool aciotest_icca_handler_update(
     struct aciodrv_device_ctx *device, uint8_t node_id, void *ctx)
 {
-    struct icca_handler_ctx *icca_ctx = (struct icca_handler_ctx*)ctx;
+    struct icca_handler_ctx *icca_ctx = (struct icca_handler_ctx *) ctx;
 
     if (icca_ctx->init == false) {
         icca_ctx->init = true;

src/main/aciotest/main.c

@@ -85,8 +85,8 @@ int main(int argc, char **argv)
 
     log_to_writer(log_writer_stdout, NULL);
 
-
+    struct aciodrv_device_ctx *device =
-    struct aciodrv_device_ctx *device = aciodrv_device_open_path(argv[1], atoi(argv[2]));
+        aciodrv_device_open_path(argv[1], atoi(argv[2]));
 
     if (!device) {
         printf("Opening acio device failed\n");

src/main/aciotest/panb.c

@@ -3,27 +3,29 @@
 #include <stdio.h>
 #include <stdlib.h>
 
-#include "aciodrv/panb.h"
 #include "aciodrv-proc/panb.h"
+#include "aciodrv/panb.h"
 
 struct panb_handler_ctx {
     bool running;
 };
 
-bool aciotest_panb_handler_init(struct aciodrv_device_ctx *device, uint8_t node_id, void **ctx)
+bool aciotest_panb_handler_init(
+    struct aciodrv_device_ctx *device, uint8_t node_id, void **ctx)
 {
     if (node_id != 0) {
         return true;
     }
 
     *ctx = malloc(sizeof(struct panb_handler_ctx));
-    struct panb_handler_ctx *panb_ctx = (struct panb_handler_ctx*)*ctx;
+    struct panb_handler_ctx *panb_ctx = (struct panb_handler_ctx *) *ctx;
     panb_ctx->running = true;
 
     return aciodrv_proc_panb_init(device);
 }
 
-bool aciotest_panb_handler_update(struct aciodrv_device_ctx *device, uint8_t node_id, void *ctx)
+bool aciotest_panb_handler_update(
+    struct aciodrv_device_ctx *device, uint8_t node_id, void *ctx)
 {
     uint8_t button[AC_IO_PANB_MAX_KEYS];
     struct ac_io_panb_poll_out state;
@@ -32,19 +34,19 @@ bool aciotest_panb_handler_update(struct aciodrv_device_ctx *device, uint8_t nod
     if (node_id != 0) {
         return true;
     }
-    
+
     if (!panb_ctx->running) {
         printf(">>> PANB:\nDevice has been closed. Press Ctrl+C to exit.");
         return true;
     }
-    
+
     if (!aciodrv_proc_panb_get_state(button)) {
         return false;
     }
 
     printf(">>> PANB:\nPress first and last keys to close device\n");
 
-    for (int i=0; i<AC_IO_PANB_MAX_KEYS; i++) {
+    for (int i = 0; i < AC_IO_PANB_MAX_KEYS; i++) {
         printf("%01X ", button[i]);
     }
     printf("\n");
@@ -52,25 +54,25 @@ bool aciotest_panb_handler_update(struct aciodrv_device_ctx *device, uint8_t nod
     /* I added a key combo to properly close the module.
      * Leaving the PANB device in autopolling state without ever
      * reading packets from the serial interface eventually
-     * makes it fall into a state where it doesn't send anything anymore 
+     * makes it fall into a state where it doesn't send anything anymore
      * and won't even respond to a reset, thus requiring a power cycle.
      */
-    if (button[0] && button[AC_IO_PANB_MAX_KEYS-1]) {
+    if (button[0] && button[AC_IO_PANB_MAX_KEYS - 1]) {
         aciodrv_proc_panb_fini(device);
         panb_ctx->running = false;
         return true;
     }
 
     /* light the panel */
-    for (int i=0; i<AC_IO_PANB_MAX_KEYS; i++) {
+    for (int i = 0; i < AC_IO_PANB_MAX_KEYS; i++) {
-        state.key[i].green = (button[i])? 0x7F : 0;
+        state.key[i].green = (button[i]) ? 0x7F : 0;
         state.key[i].red = 0;
-        state.key[i].blue = (button[i])? 0x23 : 0;
+        state.key[i].blue = (button[i]) ? 0x23 : 0;
     }
 
     if (!aciodrv_panb_send_lamp(device, node_id, &state)) {
         return false;
     }
-    
+
     return true;
 }

src/main/aciotest/panb.h

@@ -6,7 +6,9 @@
 
 #include "aciodrv/device.h"
 
-bool aciotest_panb_handler_init(struct aciodrv_device_ctx *device, uint8_t node_id, void **ctx);
+bool aciotest_panb_handler_init(
-bool aciotest_panb_handler_update(struct aciodrv_device_ctx *device, uint8_t node_id, void *ctx);
+    struct aciodrv_device_ctx *device, uint8_t node_id, void **ctx);
+bool aciotest_panb_handler_update(
+    struct aciodrv_device_ctx *device, uint8_t node_id, void *ctx);
 
 #endif

src/main/aciotest/rvol.c

@@ -54,8 +54,7 @@ bool aciotest_rvol_handler_update(
         selected_light,
         pin.spinners[2] / 2,
         pin.spinners[3] / 2,
-        pin.spinners[4] / 2
+        pin.spinners[4] / 2);
-    );
 
     memset(&pout, 0, sizeof(pout));