@@ -104,7 +104,7 @@ The project supports building process on Windows and Linux.

 ├── fonts          # Fonts used in desktop GUI applications.

 ├── fs             # File system generator needed by the real XiPC and the XiPC Emulator.

 ├── fw

-│   ├── doc        # Documentation of the IO Board to make by Doxygen.

+│   ├── doc        # Documentation of the IO Board firmware to make by Doxygen.

 │   └── src        # Source code of the firmware for the IO Board.

 ├── ide

 │   ├── geany      # IDE configuration to support assembler for the XiPU.

@@ -103,7 +103,9 @@ The project supports building process on Windows and Linux.

 │   └── src        # Source code of the XiPC Emulator.

 ├── fonts          # Fonts used in desktop GUI applications.

 ├── fs             # File system generator needed by the real XiPC and the XiPC Emulator.

-├── fw             # Source code of the firmware for the IO Board.

+├── fw

+│   ├── doc        # Documentation of the IO Board to make by Doxygen.

+│   └── src        # Source code of the firmware for the IO Board.

 ├── ide

 │   ├── geany      # IDE configuration to support assembler for the XiPU.

 │   └── qtcreator  # IDE configuration for code rules.

@@ -77,6 +77,7 @@ The project supports building process on Windows and Linux.

 - QtCreator - IDE for C++/Qt. Used to create desktop applications.

 - Qt 5.12.4 - Multiplatform Qt 5 library. It supports UI, data structures, files etc.

 - GCC - C and C++ code compiler.

+- Keil uVision 5.37 - Compiler and debugger for the STM32F0 MCU.

 - Make - Build automation tool.

 - Doxygen 1.9.6 - Documentation generator from annotated sources.

 - Proteus 8 - Circuit simulator software. Used to simulate the XiPU.

@@ -156,7 +157,17 @@ cd rom

 make

 ```

-#### 4.2.4. Applications

+#### 4.2.4. IO Board firmware

+

+To build the IO Board firmware file, and create documentation, please type:

+

+```console

+cd fw

+make

+```

+To build successfully a firmware is needed the Keil uVision5 with a free license for STM32F0 MCUs. UV4.exe must be added to the PATH env.

+

+#### 4.2.5. Applications

 To build the user applications, please type:

@@ -165,7 +176,7 @@ cd app

 make

 ```

-#### 4.2.5. File System

+#### 4.2.6. File System

 To generate a directory with the virtual file system, please type:

@@ -174,7 +185,7 @@ cd fs

 make

 ```

-#### 4.2.6. XiPC Emulator

+#### 4.2.7. XiPC Emulator

 To build the application and create documentation, please type:

@@ -102,6 +102,7 @@ The project supports building process on Windows and Linux.

 │   └── src        # Source code of the XiPC Emulator.

 ├── fonts          # Fonts used in desktop GUI applications.

 ├── fs             # File system generator needed by the real XiPC and the XiPC Emulator.

+├── fw             # Source code of the firmware for the IO Board.

 ├── ide

 │   ├── geany      # IDE configuration to support assembler for the XiPU.

 │   └── qtcreator  # IDE configuration for code rules.

@@ -105,9 +105,8 @@ The project supports building process on Windows and Linux.

 ├── ide

 │   ├── geany      # IDE configuration to support assembler for the XiPU.

 │   └── qtcreator  # IDE configuration for code rules.

-├── io

-│   └── pcb        # PCB design for the IO Board

-├── keyboard       # PCB design for the keyboard

+├── io             # PCB design for the IO Board

+├── kbd            # PCB design for the keyboard

 ├── lib            # Binary libraries needed to run compiled applications on Windows x64.

 ├── pcb            # PCB design for the XiPU

 ├── rom            # OS with a simple terminal and IO API for applications.

@@ -81,6 +81,7 @@ The project supports building process on Windows and Linux.

 - Doxygen 1.9.6 - Documentation generator from annotated sources.

 - Proteus 8 - Circuit simulator software. Used to simulate the XiPU.

 - QCAD - DXF files editor. Used to create Plexiglas case for the XiPC.

+- DipTrace 4.2.0.1 - Schematic and PCB design software.

 ### 3.2. Project structure

@@ -104,7 +105,11 @@ The project supports building process on Windows and Linux.

 ├── ide

 │   ├── geany      # IDE configuration to support assembler for the XiPU.

 │   └── qtcreator  # IDE configuration for code rules.

+├── io

+│   └── pcb        # PCB design for the IO Board

+├── keyboard       # PCB design for the keyboard

 ├── lib            # Binary libraries needed to run compiled applications on Windows x64.

+├── pcb            # PCB design for the XiPU

 ├── rom            # OS with a simple terminal and IO API for applications.

 ├── sim            # Simulation project of the XiPU.

 └── urom

@@ -99,6 +99,7 @@ The project supports building process on Windows and Linux.

 ├── emu

 │   ├── doc        # Documentation of the XiPC Emulator to make by Doxygen.

 │   └── src        # Source code of the XiPC Emulator.

+├── fonts          # Fonts used in desktop GUI applications.

 ├── fs             # File system generator needed by the real XiPC and the XiPC Emulator.

 ├── ide

 │   ├── geany      # IDE configuration to support assembler for the XiPU.

@@ -2,30 +2,30 @@

 XiPU is an 8-bit 7400 TTL CPU project.

-## About the project

+## 1. About the project

 The XiPU is loosely based on MOS 6502. It was my starting point of design my own CPU. For now, the XiPU has many differences and it is so much simpler.

 The main goal of the project is creating a fully functional 8-bit 7400 TTL CPU and a simple computer based on the one.

-### Author

+### 1.1. Author

 - Pawel Jablonski (pj@xirx.net)

-### License

+### 1.2. License

 You can use this code however you like but leave information about the original author. Code is free for non-commercial and commercial use.

 Please see the LICENSE.txt file.

-### Links

+### 1.3. Links

 - WWW: [xirx.net](https://xirx.net "xirx.net")

 - GIT: [git.xirx.net](https://git.xirx.net "git.xirx.net")

-## Useful knowledge

+## 2. Useful knowledge

-### Dictionary

+### 2.1. Dictionary

 - XiPU - XiRX Processor Unit. The name of the 8-bit TTL CPU.

 - XiPC - XiRX Personal Computer. The name of the simple computer based on XiPU CPU

@@ -39,7 +39,7 @@ Please see the LICENSE.txt file.

 - External BUS - Data highway for IO operations.

 - ALU - Arithmetic logic unit.

-### XiPU

+### 2.2. XiPU

 - 8-bit processor based on 7400 HCT chips compatible with TTL.

 - 32 KB of ROM space for OS. It is stored in EEPROM.

@@ -56,7 +56,7 @@ Please see the LICENSE.txt file.

 	- BUS C - 16-bit memory address BUS for addressing RAM and ROM.

 - 8-bit IN and 8-bit OUT external data BUS. It is used as a simple communication way with the external word.

-### XiPC

+### 2.3. XiPC

 - Personal computer based on the XiPU.

 - 40x30 characters with 16 colors support. It uses 640x480 LCD with an 8-bit color palette to render image output.

@@ -67,9 +67,9 @@ Please see the LICENSE.txt file.

 - 4 status LEDs.

 - 7.5V max 0.5A power supply.

-## Project overview

+## 3. Project overview

-### Requirements

+### 3.1. Requirements

 The project supports building process on Windows and Linux.

@@ -78,51 +78,70 @@ The project supports building process on Windows and Linux.

 - Qt 5.12.4 - Multiplatform Qt 5 library. It supports UI, data structures, files etc.

 - GCC - C and C++ code compiler.

 - Make - Build automation tool.

-- Doxygen 1.9.5 - Documentation generator from annotated sources.

+- Doxygen 1.9.6 - Documentation generator from annotated sources.

 - Proteus 8 - Circuit simulator software. Used to simulate the XiPU.

 - QCAD - DXF files editor. Used to create Plexiglas case for the XiPC.

-### Project structure

+### 3.2. Project structure

 ```console

 .

-├── asm            # Assembler Compiler for the XiPU.

+├── LICENSE.txt    # License file.

+├── Makefile       # Main Makefile file to building binaries and documentations at once.

+├── README.md      # Readme file.

+├── app            # Applications written for the XiPC.

+├── asm

+│   ├── doc        # Documentation of the Assembler Compiler to make by Doxygen.

+│   └── src        # Source code of the Assembler Compiler.

+├── bin            # Destination directory for all generated binaries during the build process.

 ├── case           # A simple Plexiglas case project for the XiPC.

+├── doc            # Destination directory for all generated documentations during the build process.

+├── emu

+│   ├── doc        # Documentation of the XiPC Emulator to make by Doxygen.

+│   └── src        # Source code of the XiPC Emulator.

+├── fs             # File system generator needed by the real XiPC and the XiPC Emulator.

 ├── ide

 │   ├── geany      # IDE configuration to support assembler for the XiPU.

 │   └── qtcreator  # IDE configuration for code rules.

-├── lib            # Binary libraries needed to run compiled applications on Windows.

+├── lib            # Binary libraries needed to run compiled applications on Windows x64.

 ├── rom            # OS with a simple terminal and IO API for applications.

 ├── sim            # Simulation project of the XiPU.

 └── urom

     ├── doc        # Documentation of the uROM generator to make by Doxygen.

-    └── src        # Source of the uROM generator.

+    └── src        # Source code of the uROM generator.

 ```

-## Compiling

+## 4. Compiling

-### uROM

+### 4.1. Build all

-To build the application and create documentation, please type:

+To build all binaries and create documentations for them, please type:

 ```console

-cd urom

 make

 ```

-To create uROM files, please type on Windows:

+### 4.2. Build a single module

+

+#### 4.2.1 uROM

+

+To build the application and create documentation, please type:

 ```console

-./urom.exe

+cd urom

+make

 ```

-Or on Linux:

+#### 4.2.2. ASM Compiler

+

+To build the application and create documentation, please type:

 ```console

-./urom

+cd asm

+make

 ```

-### ROM

+#### 4.2.3. ROM

 To build the OS ROM image file, the map file with API handlers, and create documentation, please type:

@@ -131,35 +150,63 @@ cd rom

 make

 ```

-### ASM

+#### 4.2.4. Applications

+

+To build the user applications, please type:

+

+```console

+cd app

+make

+```

+

+#### 4.2.5. File System

+

+To generate a directory with the virtual file system, please type:

+

+```console

+cd fs

+make

+```

+

+#### 4.2.6. XiPC Emulator

 To build the application and create documentation, please type:

 ```console

-cd asm

+cd emu

 make

 ```

-To compile ROM, please type on Windows:

+## 5. Using

+

+### 5.1. uROM

+

+To generate uROM files, please type:

 ```console

-./asm.exe rom [input_file] [output_bin] [output_map]

+./urom

 ```

-Or on Linux:

+### 5.2. ASM Compiler

+

+To compile ROM, please type:

 ```console

 ./asm rom [input_file] [output_bin] [output_map]

 ```

-To compile an application, please type on Windows:

+To compile an application, please type:

 ```console

-./asm.exe app [input_file] [output_bin]

+./asm app [input_file] [output_bin]

 ```

-Or on Linux:

+#### 5.3. XiPC Emulator

+

+To run the XiPC Emulator application, please type:

 ```console

-./asm app [input_file] [output_bin]

+./emu

 ```

+

+It will show a window of the emulator ready to work. Next step is loading uROM files, ROM file and choose the directory with the virtual file system. After that, the application is ready to run emulation.

@@ -75,10 +75,10 @@ The project supports building process on Windows and Linux.

 - Geany - Multi-language IDE. Used to create Makefile, assembler code etc.

 - QtCreator - IDE for C++/Qt. Used to create desktop applications.

-- Qt 5.12.8 - Multiplatform Qt 5 library. It supports UI, data structures, files etc.

+- Qt 5.12.4 - Multiplatform Qt 5 library. It supports UI, data structures, files etc.

 - GCC - C and C++ code compiler.

 - Make - Build automation tool.

-- Doxygen 1.9.2 - Documentation generator from annotated sources.

+- Doxygen 1.9.5 - Documentation generator from annotated sources.

 - Proteus 8 - Circuit simulator software. Used to simulate the XiPU.

 - QCAD - DXF files editor. Used to create Plexiglas case for the XiPC.

@@ -86,11 +86,13 @@ The project supports building process on Windows and Linux.

 ```console

 .

+├── asm            # Assembler Compiler for the XiPU.

 ├── case           # A simple Plexiglas case project for the XiPC.

 ├── ide

 │   ├── geany      # IDE configuration to support assembler for the XiPU.

 │   └── qtcreator  # IDE configuration for code rules.

 ├── lib            # Binary libraries needed to run compiled applications on Windows.

+├── rom            # OS with a simple terminal and IO API for applications.

 ├── sim            # Simulation project of the XiPU.

 └── urom

     ├── doc        # Documentation of the uROM generator to make by Doxygen.

@@ -120,9 +122,44 @@ Or on Linux:

 ./urom

 ```

+### ROM

+To build the OS ROM image file, the map file with API handlers, and create documentation, please type:

+```console

+cd rom

+make

+```

+

+### ASM

+

+To build the application and create documentation, please type:

+

+```console

+cd asm

+make

+```

+

+To compile ROM, please type on Windows:

+

+```console

+./asm.exe rom [input_file] [output_bin] [output_map]

+```

+

+Or on Linux:

+

+```console

+./asm rom [input_file] [output_bin] [output_map]

+```

+To compile an application, please type on Windows:

+```console

+./asm.exe app [input_file] [output_bin]

+```

+Or on Linux:

+```console

+./asm app [input_file] [output_bin]

+```

@@ -0,0 +1,128 @@

+# XiPU

+

+XiPU is an 8-bit 7400 TTL CPU project.

+

+## About the project

+

+The XiPU is loosely based on MOS 6502. It was my starting point of design my own CPU. For now, the XiPU has many differences and it is so much simpler.

+

+The main goal of the project is creating a fully functional 8-bit 7400 TTL CPU and a simple computer based on the one.

+

+### Author

+

+- Pawel Jablonski (pj@xirx.net)

+

+### License

+

+You can use this code however you like but leave information about the original author. Code is free for non-commercial and commercial use.

+

+Please see the LICENSE.txt file.

+

+### Links

+

+- WWW: [xirx.net](https://xirx.net "xirx.net")

+- GIT: [git.xirx.net](https://git.xirx.net "git.xirx.net")

+

+## Useful knowledge

+

+### Dictionary

+

+- XiPU - XiRX Processor Unit. The name of the 8-bit TTL CPU.

+- XiPC - XiRX Personal Computer. The name of the simple computer based on XiPU CPU

+- TTL - Transistor-transistor logic.

+- HCT - High-Speed CMOS chips available in TTL compatible form.

+- RAM - Volatile random access memory.

+- ROM - Non-volatile read-only memory.

+- Register - Quickly accessible location for a small amount of data stored in a TTL chip.

+- uROM - uROM determines which of the internal registers is used to read from and write to at the current micro step of executing instruction.

+- IO operation - Read or write data to pins connected to external world.

+- External BUS - Data highway for IO operations.

+- ALU - Arithmetic logic unit.

+

+### XiPU

+

+- 8-bit processor based on 7400 HCT chips compatible with TTL.

+- 32 KB of ROM space for OS. It is stored in EEPROM.

+- 64 KB of RAM space. Lower 32 KB is a place for variables and temporal data. Higher 32 KB is visible as higher 32 KB of ROM space, it could be used to load and run applications.

+- 1 MHz clock speed. The processor uses a 2 MHz crystal to get two 1 MHz square waves shifted relative to the other about half.

+- The processor uses uROM stored in two EEPROMs.

+- Each instruction could be built from 2 to 16 micro steps. Each micro step took exactly 1 clock tick.

+- Four registers:

+	- A, B - 8-bit general purpose registers.

+	- X, Y - 8-bit auxiliary registers. Could be used mostly as general purpose registers. Together, it can be used as a 16-bit address register.

+- Three internal buses:

+	- BUS A - 8-bit main BUS for registers, RAM, ROM, IO operations.

+	- BUS B - 8-bit auxiliary BUS for registers used as second input for ALU.

+	- BUS C - 16-bit memory address BUS for addressing RAM and ROM.

+- 8-bit IN and 8-bit OUT external data BUS. It is used as a simple communication way with the external word.

+

+### XiPC

+

+- Personal computer based on the XiPU.

+- 40x30 characters with 16 colors support. It uses 640x480 LCD with an 8-bit color palette to render image output.

+- Mono speaker with a volume knob.

+- RS-232 with 1200 bps support.

+- RTC with battery support.

+- Built-in QWERTY keyboard.

+- 4 status LEDs.

+- 7.5V max 0.5A power supply.

+

+## Project overview

+

+### Requirements

+

+The project supports building process on Windows and Linux.

+

+- Geany - Multi-language IDE. Used to create Makefile, assembler code etc.

+- QtCreator - IDE for C++/Qt. Used to create desktop applications.

+- Qt 5.12.8 - Multiplatform Qt 5 library. It supports UI, data structures, files etc.

+- GCC - C and C++ code compiler.

+- Make - Build automation tool.

+- Doxygen 1.9.2 - Documentation generator from annotated sources.

+- Proteus 8 - Circuit simulator software. Used to simulate the XiPU.

+- QCAD - DXF files editor. Used to create Plexiglas case for the XiPC.

+

+### Project structure

+

+```console

+.

+├── case           # A simple Plexiglas case project for the XiPC.

+├── ide

+│   ├── geany      # IDE configuration to support assembler for the XiPU.

+│   └── qtcreator  # IDE configuration for code rules.

+├── lib            # Binary libraries needed to run compiled applications on Windows.

+├── sim            # Simulation project of the XiPU.

+└── urom

+    ├── doc        # Documentation of the uROM generator to make by Doxygen.

+    └── src        # Source of the uROM generator.

+```

+

+## Compiling

+

+### uROM

+

+To build the application and create documentation, please type:

+

+```console

+cd urom

+make

+```

+

+To create uROM files, please type on Windows:

+

+```console

+./urom.exe

+```

+

+Or on Linux:

+

+```console

+./urom

+```

+

+

+

+

+

+

+

new file mode 100644