Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/inpyjama/c-ninja-listings
Lower level assembly and C baremetal programming on RISC-V CPUs. Source code listings from the C-Ninja, in Pyjama! book.
https://github.com/inpyjama/c-ninja-listings
assembly-language baremetal c linker-script makefile risc-v riscv32
Last synced: 26 days ago
JSON representation
Lower level assembly and C baremetal programming on RISC-V CPUs. Source code listings from the C-Ninja, in Pyjama! book.
- Host: GitHub
- URL: https://github.com/inpyjama/c-ninja-listings
- Owner: inpyjama
- Created: 2023-08-19T03:53:54.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-11T04:35:01.000Z (6 months ago)
- Last Synced: 2024-09-30T06:04:39.152Z (about 1 month ago)
- Topics: assembly-language, baremetal, c, linker-script, makefile, risc-v, riscv32
- Language: Makefile
- Homepage: https://inpyjama.com
- Size: 3.17 MB
- Stars: 85
- Watchers: 8
- Forks: 420
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
```
The code provided as part of this repository is ONLY for learning purposes!
```
# Code Listings for "C-Ninja, in Pyjama!"
This repository contains code listings cited as examples from the book "**C Ninja, in Pyjama!**". There is also supporting YouTube playlist that guides through the chapters and concepts.
Embedded Systems 101: C Ninja, in Pyjama! The right way to learn C...
# Environment Setup
All the examples are based on the RISC-V CPU implementing the **rv32i** instruction set. To avoid having to procure/purchase new hardware, the examples are based on the QEMU emulator that emulates the intended CPU. This makes it easy to learn all the core concepts first before trying to execute them on a real hardware.
To ensure that everyone has the same development environment, we create and use a docker container. Following steps guide on setting up the right docker container locally.
## 1. Setup Docker Container
You would need to have Docker engine/desktop installed and running. If you don't already have it, get a copy and install it for your Operating system by following steps here: [Docker](https://www.docker.com).
### 1.1. Mac OS
Execute the following to run the setup after [Docker](https://www.docker.com) is installed and actively running on your local machine.
```bash
bash setup.sh
```
#### 1.1.1. Testing the container
Example of correctly setup environment...
Open a new terminal window. If you are using the `bash` shell then simply execute the following:
```bash
c-ninja
```
Important: If you are using some other shell, please change to the `bash` shell first by executing the `bash` command! Once you are in the bash shell is activated, execute the `c-ninja` command.
Once within the docker container, execute the following:
```bash
c-ninja@c-ninja-linux ~/Documents
% cd test
c-ninja@c-ninja-linux ~/Documents/test
% make
```
You should see prints as below:
```bash
riscv64-unknown-elf-gcc -O0 -ggdb -nostdlib -march=rv32i -mabi=ilp32 -Wl,-Tmain.ld main.s -o main.elf
riscv64-unknown-elf-objcopy -O binary main.elf main.bin
xxd -e -c 4 -g 4 main.bin
00000000: 00100093 ....
```
## 1.2. Linux
The installation of docker is described in detail on the official Docker website: [Docker installation on Linux](https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository). We cover the steps needed to enable Docker Desktop on Ubuntu Desktop.
#### 1.2.1 Installing Docker Desktop
Installing docker Desktop on Linux is not straight forward when compared to Mac and Windows.
#### 1.2.1.1 Update APT sources
Open a terminal and update the `apt` sources by executing the following commands:
```bash
# Add Docker's official GPG key:
sudo apt-get update
sudo apt-get install ca-certificates curl gnupg
sudo install -m 0755 -d /etc/apt/keyrings
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /etc/apt/keyrings/docker.gpg
sudo chmod a+r /etc/apt/keyrings/docker.gpg
# Add the repository to Apt sources:
echo \
"deb [arch="$(dpkg --print-architecture)" signed-by=/etc/apt/keyrings/docker.gpg] https://download.docker.com/linux/ubuntu \
"$(. /etc/os-release && echo "$VERSION_CODENAME")" stable" | \
sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
sudo apt-get update
```
#### 1.2.1.2 Install Docker CLI
Install the dependencies along with `docker-ce-cli`.
```bash
sudo apt-get install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin curl qemu-system-x86 pass uidmap
```
#### 1.2.1.3 Install Docker Desktop
Download the [Docker Desktop Installer](https://desktop.docker.com/linux/main/amd64/docker-desktop-4.24.0-amd64.deb?utm_source=docker&utm_medium=webreferral&utm_campaign=docs-driven-download-linux-amd64). This should download the `docker-desktop-4.24.0-amd64.deb` file. From the location where this file is downloaded, execute the following command to install the Docker Desktop -
```bash
sudo dpkg -i docker-desktop-4.24.0-amd64.deb
```
#### 1.2.1.4 Fix the launch of Docker Desktop
```bash
sudo rm /etc/xdg/systemd/user/docker-desktop.service
systemctl --user enable docker-desktop
```
### 1.2.2 Create the Image and the Container
Ensure Docker Desktop is running and from within the directory for this current repository run the following:
```bash
bash setup.sh
```
This will create the image and the container.
#### 1.2.3 Testing Installation
Open a new terminal window. If you are using the `bash` shell then simply execute the following:
```bash
c-ninja
```
#### 1.2.3.1. Linux Host Only: Change Ownership of the directory!
Once within the docker container, you will need to change the ownership of the contents within `~/Documents/` in the container. Execute the command as shown below:
```bash
c-ninja@c-ninja-linux ~/Documents
% sudo chown -R c-ninja .
```
This will change the ownership of the files to the local user `c-ninja` within the docker container. After this you should be able to issue `cd test; make` as below -
```bash
c-ninja@c-ninja-linux ~/Documents
% cd test
c-ninja@c-ninja-linux ~/Documents/test
% make
```
This should result in prints as below, confirming that the environment is set correctly.
```bash
riscv64-unknown-elf-gcc -O0 -ggdb -nostdlib -march=rv32i -mabi=ilp32 -Wl,-Tmain.ld main.s -o main.elf
riscv64-unknown-elf-objcopy -O binary main.elf main.bin
xxd -e -c 4 -g 4 main.bin
00000000: 00100093 ....
```
### 1.3. Windows
Execute the following to run the setup after [Docker](https://www.docker.com) is installed and actively running on your local machine. You can either double-click this file or execute it from the `cmd`/`power shell` prompt. This command has been tested on Windows 11.
```bash
setup.bat
```
These commands should download the required Linux image, create a container using it, install all the required packages, create the `c-ninja` user, and map the current directory as the `~/Documents`
#### 1.3.1. Testing the installation
You should see a new, `c-ninja.bat` file generated in the current directory. You can double-click on the file to launch the terminal connected to the docker container.
## 2. Setup VScode
- [Download and Install Vscode](https://code.visualstudio.com/download) for your operating system.
- Launch VScode, open the terminal, and install the extensions -
```bash
code --install-extension ms-vscode-remote.remote-containers
code --install-extension ms-vscode-remote.remote-ssh
code --install-extension ms-vscode-remote.remote-ssh-edit
code --install-extension ms-vscode.remote-explorer
code --install-extension zhwu95.riscv
code --install-extension ZixuanWang.linkerscript
```
- Restart VSCode and from the Remote explorer connect to the container.
# Copyright
Copyright © 2023 inpyjama.com. All Rights Reserved.