board/sandbox/sandbox/README.sandbox

   1 /*
   2  * Copyright (c) 2011 The Chromium OS Authors.
   3  *
   4  * See file CREDITS for list of people who contributed to this
   5  * project.
   6  *
   7  * This program is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License as
   9  * published by the Free Software Foundation; either version 2 of
  10  * the License, or (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  20  * MA 02111-1307 USA
  21  */
  22
  23 Native Execution of U-Boot
  24 ==========================
  25
  26 The 'sandbox' architecture is designed to allow U-Boot to run under Linux on
  27 almost any hardware. To achieve this it builds U-Boot (so far as possible)
  28 as a normal C application with a main() and normal C libraries.
  29
  30 All of U-Boot's architecture-specific code therefore cannot be built as part
  31 of the sandbox U-Boot. The purpose of running U-Boot under Linux is to test
  32 all the generic code, not specific to any one architecture. The idea is to
  33 create unit tests which we can run to test this upper level code.
  34
  35 CONFIG_SANDBOX is defined when building a native board.
  36
  37 The chosen vendor and board names are also 'sandbox', so there is a single
  38 board in board/sandbox/sandbox.
  39
  40 CONFIG_SANDBOX_BIG_ENDIAN should be defined when running on big-endian
  41 machines.
  42
  43 Note that standalone/API support is not available at present.
  44
  45 The serial driver is a very simple implementation which reads and writes to
  46 the console. It does not set the terminal into raw mode, so cursor keys and
  47 history will not work yet.
  48
  49
  50 Tests
  51 -----
  52
  53 So far we have no tests, but when we do these will be documented here.