00ReadMe.text 2.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091
  1. Contents of samo-lib directory
  2. ==============================
  3. drivers
  4. The low level device drivers for C33 peripherals
  5. and external devices such as the CTP
  6. fatfs
  7. The tiny FAT file system code from http://elm-chan.org/ used to
  8. access the FAT32 files on th micro SD Card. This version does not
  9. use long file names, only the standard 8.3 is supported.
  10. flash
  11. This creates flash.elf which is a program to run on the WikiReader
  12. device to copy the contents of a 64kB file called flash.rom to the
  13. internal SPI FLASH ROM chip.
  14. forth
  15. An almost complete ANSI Forth implementation along with some scripts
  16. in the programs sub-directory used for device testing. The
  17. forth.elf program can be booted by the mbr program and run forth
  18. programs (*.4th) directly from the micro SD card.
  19. There is a simple menu program that displays certain files (*.4mu)
  20. that can be run via CTP/LCD without requiring access to the serial
  21. console.
  22. include
  23. Some header files containing C33 CPU register definitions and
  24. in-line functions for hardware initialisation.
  25. There is an important configuration file here: config.h create this
  26. from config.h-default and uncomment the "#define BOARD_SAMO_V1 1" to
  27. enable compilation for production hardware.
  28. lzma
  29. Decompression library used by the wiki-app program.
  30. mahatma
  31. Startup code for the wiki-app program, this produces the statically
  32. linked WikiReader application that is installed on the SD card as
  33. kernel.elf This only contains some interface code between the
  34. drivers and the higher level application (in the wiki-app directory
  35. one level up).
  36. mbr
  37. This is the code that goes into the on-board FLASH ROM chip. It
  38. consists of a boot block (mbr) of 512 bytes that is loaded by the
  39. CPU into internal RAM during the power-on reset sequence.
  40. There are also a set of applications that are loaded into the FLASH
  41. mostly for production testing or hardware diagnostics via the
  42. console port.
  43. After mbr has been loaded it loads the menu application which, if no
  44. character is received on the console will load the kernel.elf after a
  45. short delay. Once control is transfered to the application the
  46. FLASH is not used until the next power cycle. Holding search key
  47. down during boot will load the forth.elf program, which allows some
  48. test programs to run.
  49. The console (19200 8N1) can be used to run some tests of SDRAM and
  50. keys.
  51. The image file flash.rom is here.
  52. mini-libc
  53. These are a minimum set of stdio/stdlib routines used by the wiki-app
  54. misc-files
  55. Some additional files that are copied to the micro SD card
  56. Mk
  57. Files include by various Makefiles for standard rules and definitions
  58. scripts
  59. Some scripts used during early testing