mfld-fr / elks Goto Github PK

This project forked from ghaerr/elks

Embeddable Linux Kernel Subset

License: Other

Shell 1.82% Makefile 2.63% C 88.65% Assembly 2.99% C++ 0.57% HTML 0.27% Max 0.08% Yacc 0.47% Limbo 0.10% Lex 0.10% M4 0.17% Perl 0.01% Objective-C 0.01% Roff 1.83% Logos 0.17% Awk 0.03% SWIG 0.11% Forth 0.01%

elks's Introduction

What is this ?

This is a project to write a Linux-like OS for systems based on the Intel IA16 architecture (16 bits processors: 8088, 8086, 80188, 80186, 80286, Nec V20, V30 and compatibles).

Such systems are ancient computers (IBM-PC XT / AT and clones), or more recent SBC / SoC / FPGA that reuse the huge hardware & software legacy from that popular platform.

Watch ELKS in action (thanks @xrayer): https://www.youtube.com/watch?v=6rwlqmdebxk

How to build ?

Prerequisites

To build ELKS, you need a GNU development environment, including:

flex
bison
texinfo
libncurses5-dev

Quickstart

A script is provided to automate the whole build process (cross toool chain, configuration, kernel, user land and target image), and make it easier for ELKS newbies:

./build.sh

Note: all the scripts must be executed within the top folder of the ELKS repository as the current one (= TOPDIR).

If you want to clean everything up afterwards (except the cross tool chain):

./clean.sh

Build steps

1- Create a cross subfolder:

mkdir cross

2- Build the cross tool chain, mainly based on a recent GCC-IA16 (DEV86 including BCC was used for previous versions, but has been dropped because it was obsolete and no more maintained):

tools/build.sh

Ubuntu 18.04 LTS users: as this step is quite long, you can download an already built cross folder from here: https://github.com/elks-org/elks/actions?query=workflow%3Across

3- Set up your environment (PATH, TOPDIR and CROSSDIR):

. ./env.sh (note the '.' before the script)

4- Configure the kernel, the user land and the target image format:

make menuconfig

5- Build the kernel, the user land and the target image:

make all

The target root folder is built in target', and depending on your configuration, that folder is packed as either a floppy disk image (fd360, fd720, fd1440), a hard disk image (hd, without MBR), or a file image (ROM, TAR), into the image folder.

6- Before writting that image on the real medium, you can test it first on QEMU:

./qemu.sh

7- You can then modify the configuration or the sources and repeat from the step 4 after cleaning only the kernel, the user land and the image:

make clean

More information

Questions? Problems? Patches? Open an issue in this project!

You can also join and email the 'Linux-8086' list at [email protected].

More information in the Documentation folder: Documentation/index.html

elks's People

Contributors

Stargazers

Watchers

elks's Issues

[ne2k] Georg's feedback

Feedback from @georgp24:

full3 has owner:group as root:root. The old makefile managed to generate a full3 file which does not have root as owner.
please do not include "-k fr" in qemu.sh as default. I got very strange keyboard reactions.
document as "tcpdump -r qemu-vlan0.pcap" (to help dummies)

Perhaps add a README-NE2K file with a few instructions in elks/root while developing.

Tune the existing ROMFS for a real Flash

To be able to boot ELKS from the Flash of my SBC, tune the existing ROMFS to store the root filesystem in that Flash, as the kernel with the CONFIG_ROMCODE option.

Guidelines:
http://www.spinics.net/lists/linux-8086/msg00716.html

Move ne2k.h

Can you move ne2k.h to linuxmt so I can better include it with ktcp?

[eth] Add ioctl() to get / set MAC address

The Ethernet driver should provide a way for the user to get or set the MAC address, that is needed to build the packet to send, or to filter the received packet in promiscuous mode.

ne2k_rx_status() for select()

Telnet test

Check that the existing telnet client is working.

Option CONFIG_ETH

/dev/eth

ETH test program

NE2K test program

ktcp will not start

You have to add "-serial pty" to the qemu.sh script or ktcp will not start since /dev/ttyS0 does not work.

Since your version still includes the faulty "fs/select.c" file, the command "netstat" will not work but crash with the "panic waitpt" message.

I suggest to use the fs/inode.c and fs/namei.c files from my commit as well to avoid hunting for errors unnecessarily.

Qemu script

As far as I am aware, it is "keyb=en-us" and not "keyb=us". However, en-us did not work for me, so it is better to specify "keyb=".

Ethernet driver skeleton

To test loop between user and kernel space.

Add packet driver for NE2K compatible

As the Asix AX88796-L chip on my SBC is claimed to be NE2K compatible in its datasheet, implement a tiny packet driver that could be connected later as backend to ktcp.

For implementation guidelines:
http://www.spinics.net/lists/linux-8086/msg00722.html
http://www.spinics.net/lists/linux-8086/msg00719.html

ne2k_reset() loop & wait

DHCP tiny client

Needed to allocate IP address in user QEMU networking mode.

Menuconfig

In the current version there is only one network device drivers option: "NE2K device driver". Please leave the other options and just add the NE2K device driver.

ARP protocol

[romfs] Replace low-level routines by generic code

The ROM filesystem implementation currently uses low-level routines in assembly that could be replaced by a little more C lines and using the existing memory routines.

Issue created as an outcome of the code review in jbruchon#160.

Make network card visible on the host

For testing one would need to send some data from the host to the network card. This way one could test the receive function. The card:
"ne2k_isa.0: index=0,type=nic,model=ne2k_isa,macaddr=52:54:00:12:34:56"
should show up on the host with ifconfig -a for this.

Since Marc-Francois knows Qemu in and out he could give some instructions how to do that.

I was thinking along the lines of these instructions perhaps:
https://en.wikibooks.org/wiki/QEMU/Networking
http://wiki.qemu-project.org/Features/HelperNetworking

Reactivate this fork as new origin
Redirect all forward branches to origin (master, next, marcin)

@marcin-laszewski's patching:

Apply the remaining patches : DONE in marcin branch
Push marcin branch to upstream : DONE in jbruchon#357