Improve documentation

doc/devices.md

@@ -0,0 +1,210 @@
+# MOROS Devices
+
+Creating the devices in the file system:
+
+    write /dev/
+    write /dev/ata/
+    write /dev/ata/0/
+    write /dev/ata/0/0 -d ata-0-0
+    write /dev/ata/0/1 -d ata-0-1
+    write /dev/ata/1/
+    write /dev/ata/1/0 -d ata-1-0
+    write /dev/ata/1/1 -d ata-1-1
+    write /dev/clk/
+    write /dev/clk/boot -d clk-boot
+    write /dev/clk/epoch -d clk-epoch
+    write /dev/clk/rtc -d clk-rtc
+    write /dev/console -d console
+    write /dev/net/
+    write /dev/net/tcp -d net-tcp
+    write /dev/net/udp -d net-udp
+    write /dev/net/gw -d net-gw
+    write /dev/net/ip -d net-ip
+    write /dev/net/mac -d net-mac
+    write /dev/net/usage -d net-usage
+    write /dev/null -d null
+    write /dev/random -d random
+    write /dev/speaker -d speaker
+    write /dev/vga/
+    write /dev/vga/buffer -d vga-buffer
+    write /dev/vga/font -d vga-font
+    write /dev/vga/mode -d vga-mode
+    write /dev/vga/palette -d vga-palette
+
+## Clock Devices
+
+Reading the number of seconds since boot:
+
+    > read /dev/clk/boot
+    89.570360
+
+Reading the number of seconds since Unix Epoch:
+
+    > read /dev/clk/epoch
+    1730398385.175973
+
+Reading the real time clock (RTC):
+
+    > read /dev/clk/rtc
+    2024-10-31 18:20:02
+
+Changing the system time:
+
+    > print 2025-01-01 00:00:00 => /dev/clk/rtc
+    [580.327629] RTC 2025-01-01 00:00:00 +0000
+
+## Console Device
+
+Reading `/dev/console` with a 4 bytes buffer will return a character from the
+keyboard or the serial interface. Reading with a larger buffer will return a
+complete line.
+
+## Network Devices
+
+### Network Config Devices
+
+The prefered way to setup the network is to use the `dhcp` command:
+
+    > dhcp
+    [958.810995] NET IP 10.0.2.15/24
+    [958.812995] NET GW 10.0.2.2
+    [958.818994] NET DNS 10.0.2.3
+
+But it is possible to do it manually with the `/dev/net/ip` and `/dev/net/gw`
+device files, and the `/ini/dns` configuration file:
+
+    > print 10.0.2.15/24 => /dev/net/ip
+    [975.123511] NET IP 10.0.2.15/24
+
+    > print 10.0.2.2 => /dev/net/gw
+    [985.646908] NET GW 10.0.2.2
+
+    > print 10.0.2.3 => /ini/dns
+
+Reading `/dev/net/mac` will return the MAC address:
+
+    > read /dev/net/mac
+    52-54-00-12-34-56
+
+### Network Usage Device
+
+Reading `/dev/net/usage` will return the network usage:
+
+    > read /dev/net/usage
+    0 0 0 0
+
+    > dhcp
+    [7.910795] NET IP 10.0.2.15/24
+    [7.911795] NET GW 10.0.2.2
+    [7.915795] NET DNS 10.0.2.3
+
+    > read /dev/net/usage
+    2 1180 2 620
+
+    > http example.com => /dev/null
+
+    > read /dev/net/usage
+    10 3306 10 1151
+
+The output format is:
+
+    <recv packets> <recv bytes> <sent packets> <sent bytes>
+
+### Network Socket Devices
+
+Opening `/dev/net/tcp` or `/dev/net/udp` with the `OPEN` syscall and the device
+flag will return a file handle for a TCP or UDP socket supporting the standard
+`READ` and `WRITE` syscalls after establishing a connection using the
+`CONNECT`, or `LISTEN` and `ACCEPT` syscalls.
+
+The size of those files give the maximum size of the buffer that can be used
+when reading or writing to a socket:
+
+    > list /dev/net
+    1446 2024-09-28 09:57:55 tcp
+    1458 2024-09-28 09:57:55 udp
+
+Reading a socket with a 1 byte buffer will return the status of the socket:
+
+    +-----+--------------+
+    | Bit | Status       |
+    +-----+--------------+
+    |  0  | Is Listening |
+    |  1  | Is Active    |
+    |  2  | Is Open      |
+    |  3  | Can Send     |
+    |  4  | May Send     |
+    |  5  | Can Recv     |
+    |  6  | May Recv     |
+    |  7  | Reserved     |
+    +-----+--------------+
+
+## Speaker Device
+
+Playing a 440 Hz sound on the PC speaker:
+
+    > print 440 => /dev/speaker
+
+Stopping the sound:
+
+    > print 0 => /dev/speaker
+
+## Null Device
+
+Writing to `/dev/null` will discard any data sent to it:
+
+    > print hello
+    hello
+
+    > print hello => /dev/null
+
+It can be used to suppress errors:
+
+    > copy none.txt some.txt
+    Error: Could not read file 'none.txt'
+
+    > copy none.txt some.txt [2]=> /dev/null
+
+## Random Device
+
+Reading from `/dev/random` will return bytes from a cryptographically secure
+random number generator that uses the [HC-128][1] algorithm seeded from the
+[RDRAND][2] instruction when available.
+
+[1]: https://en.wikipedia.org/wiki/HC-256
+[2]: https://en.wikipedia.org/wiki/RDRAND
+
+## VGA Devices
+
+### VGA Font Device
+
+Changing the VGA font:
+
+    > copy /ini/fonts/zap-light-8x16.psf /dev/vga/font
+
+### VGA Mode Device
+
+Changing the VGA mode:
+
+    > print 320x200 => /dev/vga/mode
+
+The accepted modes are:
+
+- `80x25` for the primary text mode with 16 colors
+- `320x200` for the primary graphics mode with 256 colors
+- `640x480` for the secondary graphics mode with 16 colors
+
+It is possible to read the current mode from this device file.
+
+### VGA Palette Device
+
+Changing the VGA palette is done by writting a 768 bytes buffer to
+`/dev/vga/palette` containing the RGB values of 256 colors.
+
+It is possible to read the current palette from this device file.
+
+### VGA Buffer Device
+
+Changing the VGA framebuffer is done by writting a 64 KB buffer to
+`/dev/vga/buffer` containing the color index of each pixel on the screen while
+in `320x200` mode.

doc/filesystem.md

@@ -57,6 +57,9 @@ The next step during setup is to create the directory structure:
     > write /usr/           # User directories
     > write /var/           # Variable files
 
+See the [devices](devices.md) documentation to create the device files in the
+`/dev` directory.
+
 Then the following should be added to the boot script with the
 command `edit /ini/boot.sh` to allow MOROS to finish booting:
 
@@ -157,7 +160,7 @@ Structure:
 A directory entry represents a file or a directory contained inside a
 directory. Each entry use a variable number of bytes that must fit inside the
 data of one block. Those bytes represent the kind of entry (file or dir), the
-address of the first block, the filesize (max 4GB), the last modified time in
+address of the first block, the filesize (max 4 GB), the last modified time in
 seconds since Unix Epoch, the length of the filename, and the filename (max
 255 chars) of the entry.
 
@@ -176,8 +179,9 @@ Structure:
 
 ### FileInfo
 
-The `info` syscall on a file or directory and the `read` syscall on a directory
-return a subset of a directory entry for userspace programs.
+The `INFO` syscall on a file or directory and the `READ` syscall on a directory
+return a subset of a directory entry for userspace programs. See the
+[syscalls](syscalls.md) documentation for more information.
 
 Structure: