Difference between revisions of "Main Page"

From Embedded Xinu
Jump to navigation Jump to search
(moved guide section to top; this is what people want to see)
 
(88 intermediate revisions by 11 users not shown)
Line 1: Line 1:
−
Welcome to the XINU for Routers Main Page. This is for developing documentation for our development process that began in the summer of 2006.  As this is a wiki, you can sign up and begin adding and editing content, uploading images, and generating the needed documentation for our efforts.
+
= Welcome SIGCSE 2024! =
 +
To find RISC-V assignments and writeups, see [https://github.com/a1g3/riscv-xinu-hw]. We have instructions for running Embedded Xinu on the Sipeed Nezha below.  Check out "Building an Embedded Xinu Laboratory".  For solutions to homework assignments, please email dennis (dot) brylow (at) marquette.edu or alexander (dot) gebhard (at) marquette.edu.
  
 +
= Introduction =
 +
'''Embedded Xinu''' is an ongoing research and implementation project in the area of Operating Systems and Embedded Systems.  Its original goal was to re-implement and port the [[Xinu|Xinu Operating System]] to several embedded MIPS platforms, such as the Linksys [[WRT54GL]] router.  Since then, Embedded Xinu has been ported to other platforms, such as the [[mipsel-qemu|QEMU MIPSel virtual environment]] and the [[Raspberry Pi]]; see the [[list of supported platforms]].  Although Embedded Xinu is still being developed and ported to new platforms, a laboratory environment and curriculum materials are already in use for courses in Operating Systems, Hardware Systems, Embedded Systems, Networking, and Compilers at Marquette University and other colleges/universities.
  
−
== Guides to Replicate Our Work ==
+
The Embedded Xinu project was conceived and is supervised by [https://www.cs.mu.edu/~brylow/ Dr. Dennis Brylow] and is being conducted by both graduate and undergraduate students in the [[Systems Laboratory]] in the [https://www.cs.mu.edu/ Computer Science] department of [https://www.mu.edu/ Marquette University] in Milwaukee, Wisconsin.  The first major phase of work on Embedded Xinu began in the Summer of 2006.
−
* [[HOWTO:Install OpenWRT|Install OpenWRT]]
 
−
* [[HOWTO:Connect a serial console|Connect a serial console]]
 
−
* [[HOWTO:Run your own code|Run your own code]]
 
  
−
== Project Outline ==
+
Our project partners include [https://www.cse.buffalo.edu/~bina/ Dr. Bina Ramamurthy] at University of Buffalo (with whom we shared an [https://www.nsf.gov/pubs/2009/nsf09529/nsf09529.html NSF CCLI] grant), [https://cs.olemiss.edu/~ruth/wiki/doku.php Dr. Paul Ruth] at University of Mississippi, and [https://www.cs.purdue.edu/people/comer Dr. Doug Comer] (father of Xinu) at Purdue University.
−
* Goals
 
−
# '''Infect''' WRT54GL Routers with a XINU kernel
 
−
# '''Develop''' XINU to a point where it can '''control''' the router's basic functions
 
−
# '''Use''' this platform for a course in '''embedded systems''' and/or '''networking'''
 
−
* Hardware (Mod that LinkSys!)
 
−
** [[Why we add serial ports|'''Why''' we add serial ports]]
 
−
** '''How''' we add serial ports
 
−
*** [[Pictures]] of building
 
−
*** [[Wiring|Wiring Diagrams]]
 
−
*** [[Chips|Chip Diagrams]]
 
−
* Software
 
−
** [[How to connect]] to a modified router
 
−
** Our Project's [[Directory Structure]]
 
−
** And then there was light: the [[Common Firmware Environment]]
 
−
*** Interacting with the [[CFE Command Line Interface]]
 
−
*** Fun freebies in the [[CFE API]]
 
−
*** How code can [[Interface with CFE]]
 
−
** [[OpenWRT]] (When all else fails, steal it from Linux!)
 
−
*** Important [[OpenWRT places of interest]]
 
−
** [[XINU]] (an O/S of our own)
 
  
 +
== Teaching With Embedded Xinu ==
  
 +
* For curriculum guidance on adopting or adapting Embedded Xinu for undergraduate coursework, see [[Teaching With Xinu]].
 +
* Workshops have been held regarding teaching with Embedded Xinu.  For example, the [https://www.cs.olemiss.edu/acmse2010/pdf/xinu.pdf Teaching With Embedded Xinu Workshop] at [https://www.cs.olemiss.edu/acmse2010/Home.htm ACMSE 2010] in Oxford, Mississippi (Ole Miss campus) shared ready-made curriculum resources that have been used successfully to teach hardware systems, operating systems, realtime/embedded systems, networking, and compilers with the Embedded Xinu platform at several colleges/universities.
  
−
== More Research ==
+
== Building an Embedded Xinu Laboratory ==
−
* TODO: (concrete tasks)
 
−
** XINU Tasks
 
−
*** Complete wired NIC driver.
 
−
*** Start on wireless NIC driver and "RoboSwitch".
 
−
*** Integrate XINU TCP/IP stack.
 
−
* TOTHINK: (abstract goals and wishlists)
 
−
** Learn more about the [[memory structure]] and underlying hardware.
 
−
** How should the loader discover hardware parameters if CFE does not implement device enumeration?
 
−
** How do we safely access flash memory without bricking the router?
 
  
−
== Useful Links ==
+
In this section we are developing instructions so that other groups can benefit from the work we are doing.  These guides can be followed more or less in order to create a relatively inexpensive platform for a custom operating system.  As our work develops further, there will be more Xinu-specific information.
−
* http://www.openwrt.org
+
 
−
* http://linux.junsun.net/porting-howto/ - Linux MIPS Porting Guide
+
# Obtain a [[List of supported platforms|supported platform]].
−
* http://www.version6.net/gallery/WRT54GL - WRT54GL Internals Pics Gallery
+
# (Required if using a Linksys/Asus router) [[HOWTO:Modify the Linksys hardware|Modify the Linksys hardware]] or [[HOWTO:Modify the ASUS hardware|Modify the ASUS hardware]]
−
* http://en.wikipedia.org/wiki/WRT54G - WRT54G Wiki
+
## [[HOWTO:Connect to a modified router|Connect to a modified router]]
−
* http://en.wikipedia.org/wiki/MIPS_architecture - MIPS Architecture
+
# [[HOWTO:Build Xinu|Build Xinu]]
−
* http://www.redhat.com/docs/manuals/enterprise/RHEL-4-Manual/gnu-linker/ - How To Write Linker Scripts
+
# [[HOWTO:Deploy Xinu|Deploy Xinu]]
−
* http://www.embedded.com/shared/printableArticle.jhtml;jsessionid=0LLEHS3YT5KWUQSNDBCSKHSCJUMEIJVN?articleID=9900048 - Linux Porting Guide
+
# (Optional) [[HOWTO:Build Backend Pool|Build a pool of backends]]
−
* http://courses.cs.vt.edu/~cs2504/spring2006/MIPSDocs/MD00090-2B-MIPS32PRA-AFP-02.50.pdf - MIPS32 Architecture For Programmers
+
# (Recommended) [[HOWTO:Backup your router|Backup your router's factory configuration]]
 +
 
 +
== Other Embedded Xinu Information ==
 +
 
 +
* MIPS [[processor]]
 +
* Main [[memory]]
 +
* [[Exception and Interrupt Handling]]
 +
* [[UART driver]]
 +
* [[TTY driver]]
 +
* [[Switch driver]]
 +
* [[Networking]]
 +
* [[Flash memory]]
 +
* [[Flashing firmware]]
 +
* [[EJTAG|Enhanced Joint Test Action Group]] debugger
 +
* [[Standard library]]
 +
* [[XinuPhone]] Internet telephony
 +
* [[Router Recovery]] aka "Debricking"
 +
* [[Development]]
 +
* [[Contributors]]
 +
 
 +
----
 +
 
 +
<small><small><small>The Xinu Lab is brought to you in part by [[XMMS|M&M's]].</small></small></small>
 +
<!--
 +
-->__NOTOC__<!-- Disable "Contents" box from showing --><!--
 +
-->__NOEDITSECTION__<!-- Disable [edit] from appearing --><!--
 +
-->

Latest revision as of 23:13, 23 March 2024

Welcome SIGCSE 2024!

To find RISC-V assignments and writeups, see [1]. We have instructions for running Embedded Xinu on the Sipeed Nezha below. Check out "Building an Embedded Xinu Laboratory". For solutions to homework assignments, please email dennis (dot) brylow (at) marquette.edu or alexander (dot) gebhard (at) marquette.edu.

Introduction

Embedded Xinu is an ongoing research and implementation project in the area of Operating Systems and Embedded Systems. Its original goal was to re-implement and port the Xinu Operating System to several embedded MIPS platforms, such as the Linksys WRT54GL router. Since then, Embedded Xinu has been ported to other platforms, such as the QEMU MIPSel virtual environment and the Raspberry Pi; see the list of supported platforms. Although Embedded Xinu is still being developed and ported to new platforms, a laboratory environment and curriculum materials are already in use for courses in Operating Systems, Hardware Systems, Embedded Systems, Networking, and Compilers at Marquette University and other colleges/universities.

The Embedded Xinu project was conceived and is supervised by Dr. Dennis Brylow and is being conducted by both graduate and undergraduate students in the Systems Laboratory in the Computer Science department of Marquette University in Milwaukee, Wisconsin. The first major phase of work on Embedded Xinu began in the Summer of 2006.

Our project partners include Dr. Bina Ramamurthy at University of Buffalo (with whom we shared an NSF CCLI grant), Dr. Paul Ruth at University of Mississippi, and Dr. Doug Comer (father of Xinu) at Purdue University.

Teaching With Embedded Xinu

  • For curriculum guidance on adopting or adapting Embedded Xinu for undergraduate coursework, see Teaching With Xinu.
  • Workshops have been held regarding teaching with Embedded Xinu. For example, the Teaching With Embedded Xinu Workshop at ACMSE 2010 in Oxford, Mississippi (Ole Miss campus) shared ready-made curriculum resources that have been used successfully to teach hardware systems, operating systems, realtime/embedded systems, networking, and compilers with the Embedded Xinu platform at several colleges/universities.

Building an Embedded Xinu Laboratory

In this section we are developing instructions so that other groups can benefit from the work we are doing. These guides can be followed more or less in order to create a relatively inexpensive platform for a custom operating system. As our work develops further, there will be more Xinu-specific information.

  1. Obtain a supported platform.
  2. (Required if using a Linksys/Asus router) Modify the Linksys hardware or Modify the ASUS hardware
    1. Connect to a modified router
  3. Build Xinu
  4. Deploy Xinu
  5. (Optional) Build a pool of backends
  6. (Recommended) Backup your router's factory configuration

Other Embedded Xinu Information

The Xinu Lab is brought to you in part by M&M's.

Retrieved from "https://xinu.cs.mu.edu/index.php?title=Main_Page&oldid=4419"