Usbfs

.gitignore

@@ -1,3 +1,7 @@
+#backup files
+*.back
+*~
+
 # Object files
 *.o
 
@@ -8,6 +12,9 @@
 *.lib
 *.a
 
+# Memory maps
+*.map
+
 # Shared objects (inc. Windows DLLs)
 *.dll
 *.so
@@ -24,11 +31,23 @@
 *.boot
 *.bin
 
+# Temporary swap files (from open Vim windows)
+[._]*.s[a-v][a-z]
+[._]*.sw[a-p]
+[._]s[a-rt-v][a-z]
+[._]ss[a-gi-z]
+[._]sw[a-p]
+
+# .nfs files are created when an open file is removed but is still being accessed
+.nfs*
+
 # Xinu build files
 compile/config/config
 compile/config/y.tab.h
 compile/config/parse.c
 compile/version
 compile/vn
 include/conf.h
+include/version.h
 system/conf.c
+

README.md

@@ -1,22 +1,22 @@
-# Embedded Xinu #
+# Embedded Xinu
 
 Embedded Xinu, Copyright (C) 2008, 2009, 2010.  All rights reserved.
 
 Version: 2.01
 
- 1. What is Embedded Xinu?
- 2. Directory Structure
- 3. Prerequisites
- 4. Installation Instructions
-    1. Build Embedded Xinu
-    2. Make serial and network connections
-    3. Enter Common Firmware Environment prompt
-    4. Set IP address
-    5. Load image over TFTP
- 5. Links
+1.  What is Embedded Xinu?
+2.  Directory Structure
+3.  Prerequisites
+4.  Installation Instructions
+    1.  Build Embedded Xinu
+    2.  Make serial and network connections
+    3.  Enter Common Firmware Environment prompt
+    4.  Set IP address
+    5.  Load image over TFTP
+5.  Supported Platforms
+6.  Links
 
-
-## 1. What is Embedded Xinu? ##
+## 1. What is Embedded Xinu?
 
 Xinu ("Xinu is not unix", a recursive acronym) is a UNIX-like operating
 system originally developed by Douglas Comer for instructional purposes at
@@ -27,82 +27,82 @@ on the MIPS processor which is able to run on inexpensive wireless routers
 and is suitable for courses and research in the areas of Operating Systems,
 Hardware Systems, Embedded Systems, Networking, and Compilers.
 
-## 2. Directory Structure ##
+## 2. Directory Structure
 
 Once you have downloaded and extracted the xinu tarball, you will see a
 basic directory structure:
 
-	AUTHORS   device/   lib/     mem/      loader/   README  system/
-	compile/  include/  LICENSE  mailbox/  network/  shell/  test/
-
- * `AUTHORS`  a brief history of contributors to the Xinu operating system
-              in it's varying iterations.
- * `compile/` contains the Makefile and other necessities for building the
-              Xinu system once you have a cross-compiler.
- * `device/`  contains directories with source for all device drivers in Xinu.
- * `include/` contains all the header files used by Xinu.
- * `lib/`     contains library folders (e.g., `libxc/`) with a Makefile and 
-              source for the library
- * `LICENSE`  the license under which this project falls.
- * `loader/`  contains assembly files and is where the bootloader will begin
-              execution of O/S code.
- * `mailbox/` contains source for the mailbox message queuing system.
- * `mem/`     contains source for page-based memory protection.
- * `network/` contains code for the TCP/IP networking stack.
- * `README`   this document.
- * `RELEASE`  release notes for the current version.
- * `shell/`   contains the source for all Xinu shell related functions.
- * `system/`  contains the source for all Xinu system functions such as the
-              nulluser process (`initialize.c`) as well as code to set up a C
-              environment (`startup.S`).
- * `test/`    contains a number of testcases (which can be run using the shell
-              command `testsuite`).
-
-## 3. Prerequisites ##
-
-### 3.1 Supported platform with hardware modification ###
+    AUTHORS   device/   lib/     mem/      loader/   README  system/
+    compile/  include/  LICENSE  mailbox/  network/  shell/  test/
+
+-   `AUTHORS`  a brief history of contributors to the Xinu operating system
+               in it's varying iterations.
+-   `compile/` contains the Makefile and other necessities for building the
+               Xinu system once you have a cross-compiler.
+-   `device/`  contains directories with source for all device drivers in Xinu.
+-   `include/` contains all the header files used by Xinu.
+-   `lib/`     contains library folders (e.g., `libxc/`) with a Makefile and
+               source for the library
+-   `LICENSE`  the license under which this project falls.
+-   `loader/`  contains assembly files and is where the bootloader will begin
+               execution of O/S code.
+-   `mailbox/` contains source for the mailbox message queuing system.
+-   `mem/`     contains source for page-based memory protection.
+-   `network/` contains code for the TCP/IP networking stack.
+-   `README`   this document.
+-   `RELEASE`  release notes for the current version.
+-   `shell/`   contains the source for all Xinu shell related functions.
+-   `system/`  contains the source for all Xinu system functions such as the
+               nulluser process (`initialize.c`) as well as code to set up a C
+               environment (`startup.S`).
+-   `test/`    contains a number of testcases (which can be run using the shell
+               command `testsuite`).
+
+## 3. Prerequisites
+
+### 3.1 Supported platform with hardware modification
 
 To run Embedded Xinu you need a supported router or virtual machine.
 Currently, Embedded Xinu supports Linksys WRT54GL, Linksys WRT160NL,
 and the Qemu-mipsel virtual machine.  For an updated list
 of supported platforms, visit:
 
-http://xinu.mscs.mu.edu/List_of_supported_platforms
+<http://xinu.mscs.mu.edu/List_of_supported_platforms>
 
 In order to communicate with the router, you need to perform a hardware
 modification that will expose the serial port that exists on the PCB.  For
 more information on this process, see:
 
-http://xinu.mscs.mu.edu/Modify_the_Linksys_hardware
+<http://xinu.mscs.mu.edu/Modify_the_Linksys_hardware>
 
-### 3.2 Cross-compiler ###
+### 3.2 Cross-compiler
 
 To build Embedded Xinu you will need a cross-compiler from your host
 computer's architecture to MIPSEL (little endian MIPS for the 54GL router)
 or MIPS (big endian for the 160NL router).  Instructions on how to do this
 can be found here:
 
-http://xinu.mscs.mu.edu/Build_Xinu#Cross-Compiler
+<http://xinu.mscs.mu.edu/Build_Xinu#Cross-Compiler>
 
-### 3.3 Serial communication software ###
+### 3.3 Serial communication software
 
 Any serial communication software will do. The Xinu Console Tools include
-a program called tty-connect which can serve the purpose for a UNIX 
-environment.  More information about the Xinu Console Tools can be found 
+a program called tty-connect which can serve the purpose for a UNIX
+environment.  More information about the Xinu Console Tools can be found
 at:
 
-http://xinu.mscs.mu.edu/Console_Tools#Xinu_Console_Tools
+<http://xinu.mscs.mu.edu/Console_Tools#Xinu_Console_Tools>
 
-### 3.4 TFTP server software ###
+### 3.4 TFTP server software
 
 A TFTP server will provide the router with the ability to download and run
 the compiled Embedded Xinu image.  
 
-## 4. Installation Instructions ##
+## 4. Installation Instructions
 
-### 4.1 Build Embedded Xinu ###
+### 4.1 Build Embedded Xinu
 
-Update the `MIPS_ROOT` and `MIPS_PREFIX` variables in compile/mipsVars to 
+Update the `MIPS_ROOT` and `MIPS_PREFIX` variables in compile/mipsVars to
 correctly point to the cross-compiler on your machine.
 
 Then, from the compile directory, simply run make, which should leave you
@@ -111,16 +111,16 @@ your router for it to run Embedded Xinu.  The default build is for the
 WRT54GL router; change the compile/Makefile `PLATFORM` variable for other
 builds.  See the compile/platforms directory for supported configurations.
 
-### 4.2 Make serial and network connections ###
+### 4.2 Make serial and network connections
 
 After creating the `xinu.boot` image you can connect the router's serial
 port to your computer and open up a connection using the following
 settings:
 
- - 8 data bits, no parity bit, and 1 stop bit (8N1)
- - 115200 bps
+-   8 data bits, no parity bit, and 1 stop bit (8N1)
+-   115200 bps
 
-### 4.3 Enter Common Firmware Environment prompt ###
+### 4.3 Enter Common Firmware Environment prompt
 
 With the serial connection open, power on the router and immediately start
 sending breaks (Control-C) to the device, if your luck holds you will be
@@ -130,16 +130,16 @@ greeted with a CFE prompt.
 
 If the router seems to start booting up, you can powercycle and try again.
 
-### 4.4 Set IP address ###
+### 4.4 Set IP address
 
 By default, the router will have a static IP address of 192.168.1.1.  If you
 need to set a different address for your network, run one of the following
 commands:
 
-    ifconfig eth0 -auto                      if you are using a DHCP server 
+    ifconfig eth0 -auto                      if you are using a DHCP server
     ifconfig eth0 -addr=*.*.*.*              for a static IP address
 
-### 4.5 Load image over TFTP ###
+### 4.5 Load image over TFTP
 
 On a computer that is network accessible from the router, start your TFTP
 server and place the xinu.boot image in the root directory that the server
@@ -150,19 +150,37 @@ Then, on the router type the command:
     CFE> boot -elf [TFTP server IP]:xinu.boot
 
 If all has gone correctly the router you will be greeted with the Xinu Shell
-(`xsh$ `), which means you are now running Embedded Xinu!
+(`xsh$`), which means you are now running Embedded Xinu!
+
+## 5. [Supported Platforms](http://xinu.mscs.mu.edu/List_of_supported_platforms)
+
+| Platforms                                                                                                                                                            | Status             | Comments                                                                                                                                                                                          |
+| -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [Linksys WRT54G v8](http://www.linksys.com/servlet/Satellite?c=L_Product_C2&childpagename=US%2FLayout&cid=1149562300349&pagename=Linksys%2FCommon%2FVisitorWrapper)  | Supported          | Tested and running at the Embedded Xinu Lab.                                                                                                                                                      |
+| [Linksys WRT54GL](http://www.linksys.com/servlet/Satellite?c=L_Product_C2&childpagename=US%2FLayout&cid=1133202177241&pagename=Linksys%2FCommon%2FVisitorWrapper)    | Supported          | This is our primary development platform, on which Xinu has been tested thoroughly.                                                                                                               |
+| [Linksys WRT54G v4 ](http://www.linksys.com/servlet/Satellite?c=L_Product_C2&childpagename=US%2FLayout&cid=1149562300349&pagename=Linksys%2FCommon%2FVisitorWrapper) | Probably Supported | The v4 is apparently the version on which WRT54GL is based, and so although the Embedded Xinu Lab has not explicitly tested it, it probably works.                                                |
+| [Linksys WRT350N](http://www.linksys.com/servlet/satellite?c=l_product_c2&childpagename=us%2flayout&cid=1162354643512&pagename=linksys%2fcommon%2fvisitorwrapper)    | Under Development  | Currently the synchronous UART Driver works.                                                                                                                                                      |
+| [Linksys WRT160NL](http://www.linksys.com/servlet/satellite?c=l_product_c2&childpagename=us%2flayout&cid=1149562300349&pagename=linksys%2fcommon%2fvisitorwrapper)   | Supported          | Newer model of router.  Full O/S teaching core functioning, including wired network interface.                                                                                                    |
+| [mipsel-qemu](http://www.qemu.org/)                                                                                                                                  | Supported          | Full O/S teaching core functioning, network support in progress.                                                                                                                                  |
+| [Raspberry Pi](http://www.raspberrypi.org)                                                                                                                           | Under Development  | Core operating system including wired networking is functional.  Some new features are still being worked on, and the full documentation (e.g. for a laboratory setup) hasn't been completed yet. |
+| [Raspberry Pi 3](http://www.raspberrypi.org)                                                                                                                         | Under development  | Work has been started remaking the low level systems to operate on the aarch64 architecture.                                                                                                      |
+
+## 6. Links
 
-## 5. Links ##
+### Embedded Xinu documentation.
 
-### The Embedded Xinu Wiki ###
+Home of the most up to date documentation about new and upcoming projects.
+
+http://embedded-xinu.readthedocs.io/en/latest/
+
+### The Embedded Xinu Wiki
 
 The home of the Embedded Xinu project
 
-    http://xinu.mscs.mu.edu/
+http://xinu.mscs.mu.edu/
 
-### Dr. Brylow's Embedded Xinu Lab Infrastructure Page ###
+### Dr. Brylow's Embedded Xinu Lab Infrastructure Page
 
 More information about the Embedded Xinu Lab at Marquette University
 
-    http://www.mscs.mu.edu/~brylow/xinu/
-
+http://www.mscs.mu.edu/~brylow/xinu/

compile/Doxygen.PROJECT_NUMBER

@@ -0,0 +1 @@
+5

compile/Makefile

@@ -14,7 +14,7 @@
 #
 # $ make PLATFORM=arm-rpi
 #
-PLATFORM := x86
+PLATFORM := arm-rpi3
 
 # Filename of boot image to create (platform can override it if really needed)
 BOOTIMAGE := xinu.boot
@@ -24,7 +24,7 @@ TOPDIR  := ..
 
 # Set the C compilation flags common to all Embedded Xinu platforms.
 # platformVars can add more flags if desired.
-CFLAGS  :=
+CFLAGS  := 
 
 # Do not perform linking until the end.
 CFLAGS  += -c
@@ -169,7 +169,7 @@ COMPILER_ROOT := $(ARCH_ROOT)$(ARCH_PREFIX)
 # Set the actual compiler and several binutils programs.
 CC       := $(COMPILER_ROOT)gcc
 AR       := $(COMPILER_ROOT)ar
-LD       := $(COMPILER_ROOT)ld
+LD       := $(COMPILER_ROOT)ld# -Map test.map
 STRIP    := $(COMPILER_ROOT)strip
 OBJCOPY  := $(COMPILER_ROOT)objcopy
 
@@ -247,7 +247,7 @@ LIB_ARC  := $(LIBS:%=$(LIBDIR)/%.a)
 MAIN_OBJ := $(MAIN_SRC:%.c=%.o)
 
 # Data is relative to the compile directory
-DATA     := data
+DATA     ?= data
 
 DATA_SRC :=
 include $(DATA:%=%/Makerules)