doc/README.vxworks

   1 #
   2 # Copyright (C) 2013, Miao Yan <miao.yan@windriver.com>
   3 # Copyright (C) 2015, Bin Meng <bmeng.cn@gmail.com>
   4 #
   5 # SPDX-License-Identifier:      GPL-2.0+
   6 #
   7
   8 VxWorks Support
   9 ===============
  10
  11 This document describes the information about U-Boot loading VxWorks kernel.
  12
  13 Status
  14 ------
  15 U-Boot supports loading VxWorks kernels via 'bootvx' and 'bootm' commands.
  16 For booting old kernels (6.9.x) on PowerPC and ARM, and all kernel versions
  17 on other architectures, 'bootvx' shall be used. For booting VxWorks 7 kernels
  18 on PowerPC and ARM, 'bootm' shall be used.
  19
  20 64-bit x86 kernel cannot be loaded as of today.
  21
  22 VxWork 7 on PowerPC and ARM
  23 ---------------------------
  24 From VxWorks 7, VxWorks starts adopting device tree as its hardware decription
  25 mechansim (for PowerPC and ARM), thus requiring boot interface changes.
  26 This section will describe the new interface.
  27
  28 For PowerPC, the calling convention of the new VxWorks entry point conforms to
  29 the ePAPR standard, which is shown below (see ePAPR for more details):
  30
  31     void (*kernel_entry)(fdt_addr, 0, 0, EPAPR_MAGIC, boot_IMA, 0, 0)
  32
  33 For ARM, the calling convention is show below:
  34
  35     void (*kernel_entry)(void *fdt_addr)
  36
  37 When booting new VxWorks kernel (uImage format), the parameters passed to bootm
  38 is like below:
  39
  40     bootm <kernel image address> - <device tree address>
  41
  42 VxWorks bootline
  43 ----------------
  44 When using 'bootvx', the kernel bootline must be prepared by U-Boot at a
  45 board-specific address before loading VxWorks. U-Boot supplies its address
  46 via "bootaddr" environment variable. To check where the bootline should be
  47 for a specific board, go to the VxWorks BSP for that board, and look for a
  48 parameter called BOOT_LINE_ADRS. Assign its value to "bootaddr". A typical
  49 value for "bootaddr" is 0x101200.
  50
  51 If a "bootargs" variable is defined, its content will be copied to the memory
  52 location pointed by "bootaddr" as the kernel bootline. If "bootargs" is not
  53 there, command 'bootvx' can construct a valid bootline using the following
  54 environments variables: bootdev, bootfile, ipaddr, netmask, serverip,
  55 gatewayip, hostname, othbootargs.
  56
  57 When using 'bootm', just define "bootargs" in the environment and U-Boot will
  58 handle bootline fix up for the kernel dtb automatically.
  59
  60 Serial console
  61 --------------
  62 It's very common that VxWorks BSPs configure a different baud rate for the
  63 serial console from what is being used by U-Boot. For example, VxWorks tends
  64 to use 9600 as the default baud rate on all x86 BSPs while U-Boot uses 115200.
  65 Please configure both U-Boot and VxWorks to use the same baud rate, or it may
  66 look like VxWorks hangs somewhere as nothing outputs on the serial console.
  67
  68 x86-specific information
  69 ------------------------
  70 Before loading an x86 kernel, two additional environment variables need to be
  71 provided. They are "e820data" and "e820info", which represent the address of
  72 E820 table and E820 information (defined by VxWorks) in system memory.
  73
  74 Check VxWorks kernel configuration to look for BIOS_E820_DATA_START and
  75 BIOS_E820_INFO_START, and assign their values to "e820data" and "e820info"
  76 accordingly. If neither of these two are supplied, U-Boot assumes a default
  77 location at 0x4000 for "e820data" and 0x4a00 for "e820info". Typical values
  78 for "e820data" and "e820info" are 0x104000 and 0x104a00. But there is one
  79 exception on Intel Galileo, where "e820data" and "e820info" should be left
  80 unset, which assume the default location for VxWorks.
  81
  82 Note since currently U-Boot does not support ACPI yet, VxWorks kernel must
  83 be configured to use MP table and virtual wire interrupt mode. This requires
  84 INCLUDE_MPTABLE_BOOT_OP and INCLUDE_VIRTUAL_WIRE_MODE to be included in a
  85 VxWorks kernel configuration.